Skip to content

aws.vpc_lattice.get_target_group

Example SQL Queries

SELECT * FROM
aws.vpc_lattice.get_target_group
WHERE
"target_group_identifier" = 'VALUE';

Description

Retrieves information about the specified target group.

Table Definition

Column NameColumn Data Type
target_group_identifier Required Input Column

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

VARCHAR
_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.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

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

VARCHAR
config

The target group configuration.

STRUCT(
"health_check" STRUCT(
"enabled" BOOLEAN,
"health_check_interval_seconds" BIGINT,
"health_check_timeout_seconds" BIGINT,
"healthy_threshold_count" BIGINT,
"matcher" STRUCT(
"http_code" VARCHAR
),
"path" VARCHAR,
"port" BIGINT,
"protocol" VARCHAR,
"protocol_version" VARCHAR,
"unhealthy_threshold_count" BIGINT
),
"ip_address_type" VARCHAR,
"lambda_event_structure_version" VARCHAR,
"port" BIGINT,
"protocol" VARCHAR,
"protocol_version" VARCHAR,
"vpc_identifier" VARCHAR
)
Show child fields
config.health_check

The health check configuration. Not supported if the target group type is LAMBDA or ALB.

Show child fields
config.health_check.enabled

Indicates whether health checking is enabled.

config.health_check.health_check_interval_seconds

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

config.health_check.health_check_timeout_seconds

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

config.health_check.healthy_threshold_count

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

config.health_check.matcher

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

Show child fields
config.health_check.matcher.http_code

The HTTP code to use when checking for a successful response from a target.

config.health_check.path

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

config.health_check.port

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

config.health_check.protocol

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

config.health_check.protocol_version

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

config.health_check.unhealthy_threshold_count

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

config.ip_address_type

The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

config.lambda_event_structure_version

The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

config.port

The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

config.protocol

The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

config.protocol_version

The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

config.vpc_identifier

The ID of the VPC. Not supported if the target group type is LAMBDA.

created_at

The date and time that the target group was created, specified in ISO-8601 format.

TIMESTAMP_S
failure_code

The failure code.

VARCHAR
failure_message

The failure message.

VARCHAR
id

The ID of the target group.

VARCHAR
last_updated_at

The date and time that the target group was last updated, specified in ISO-8601 format.

TIMESTAMP_S
name

The name of the target group.

VARCHAR
service_arns

The Amazon Resource Names (ARNs) of the service.

VARCHAR[]
Show child fields
service_arns[]
status

The status.

VARCHAR
type

The target group type.

VARCHAR