Skip to content
AWS for Query.Farm

aws.elbv2.describe_target_groups

Example SQL Queries

SELECT * FROM
aws.elbv2.describe_target_groups;

Description

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

Table Definition

Column NameColumn Data Type
load_balancer_arn Input Column

The Amazon Resource Name (ARN) of the load balancer.

VARCHAR
names Input Column

The names of the target groups.

VARCHAR[]
Show child fields
names[]
target_group_arns Input Column

The Amazon Resource Names (ARN) of the target groups.

VARCHAR[]
Show child fields
target_group_arns[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

health_check_enabled

Indicates whether health checks are enabled.

BOOLEAN
health_check_interval_seconds

The approximate amount of time, in seconds, between health checks of an individual target.

BIGINT
health_check_path

The destination for health checks on the targets.

VARCHAR
health_check_port

The port to use to connect with the target.

VARCHAR
health_check_protocol

The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

VARCHAR
health_check_timeout_seconds

The amount of time, in seconds, during which no response means a failed health check.

BIGINT
healthy_threshold_count

The number of consecutive health checks successes required before considering an unhealthy target healthy.

BIGINT
ip_address_type

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

VARCHAR
load_balancer_arns

The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.

VARCHAR[]
Show child fields
load_balancer_arns[]
matcher

The HTTP or gRPC codes to use when checking for a successful response from a target.

STRUCT(
    "http_code" VARCHAR,
    "grpc_code" VARCHAR
)
Show child fields
matcher.grpc_code

You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.

matcher.http_code

For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

For Gateway Load Balancers, this must be "200–399".

Note that when using shorthand syntax, some values such as commas need to be escaped.

port

The port on which the targets are listening. This parameter is not used if the target is a Lambda function.

BIGINT
protocol

The protocol to use for routing traffic to the targets.

VARCHAR
protocol_version

[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

VARCHAR
target_group_arn

The Amazon Resource Name (ARN) of the target group.

VARCHAR
target_group_name

The name of the target group.

VARCHAR
target_type

The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

VARCHAR
unhealthy_threshold_count

The number of consecutive health check failures required before considering the target unhealthy.

BIGINT
vpc_id

The ID of the VPC for the targets.

VARCHAR