Skip to main content

target_groups_list_only

Lists target_groups in a region or regions, for all properties use target_groups

Overview

Nametarget_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Idaws.elasticloadbalancingv2.target_groups_list_only

Fields

NameDatatypeDescription
ip_address_typestringThe type of IP address used for this target group. The possible values are ipv4 and ipv6.
health_check_interval_secondsintegerThe approximate amount of time, in seconds, between health checks of an individual target.
load_balancer_arnsarrayThe Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
matcherobject[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
health_check_pathstring[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
portintegerThe port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
targetsarrayThe targets.
health_check_enabledbooleanIndicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
protocol_versionstring[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
unhealthy_threshold_countintegerThe number of consecutive health check failures required before considering a target unhealthy.
health_check_timeout_secondsintegerThe amount of time, in seconds, during which no response from a target means a failed health check.
namestringThe name of the target group.
vpc_idstringThe identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
target_group_full_namestringThe full name of the target group.
healthy_threshold_countintegerThe number of consecutive health checks successes required before considering an unhealthy target healthy.
health_check_protocolstringThe protocol the load balancer uses when performing health checks on targets.
target_group_attributesarrayThe attributes.
target_typestringThe type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
health_check_portstringThe port the load balancer uses when performing health checks on targets.
target_group_arnstringThe ARN of the Target Group
protocolstringThe protocol to use for routing traffic to the targets.
target_group_namestringThe name of the target group.
tagsarrayThe tags.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all target_groups in a region.

SELECT
region,
target_group_arn
FROM aws.elasticloadbalancingv2.target_groups_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the target_groups_list_only resource, see target_groups