AWS::ElasticLoadBalancingV2::TargetGroup TargetGroupAttribute
Specifies a target group attribute.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
Properties
Key
-
The name of the attribute.
The following attributes are supported by all load balancers:
-
deregistration_delay.timeout_seconds
- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target fromdraining
tounused
. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. -
stickiness.enabled
- Indicates whether target stickiness is enabled. The value istrue
orfalse
. The default isfalse
. -
stickiness.type
- Indicates the type of stickiness. The possible values are:-
lb_cookie
andapp_cookie
for Application Load Balancers. -
source_ip
for Network Load Balancers. -
source_ip_dest_ip
andsource_ip_dest_ip_proto
for Gateway Load Balancers.
-
The following attributes are supported by Application Load Balancers and Network Load Balancers:
-
load_balancing.cross_zone.enabled
- Indicates whether cross zone load balancing is enabled. The value istrue
,false
oruse_load_balancer_configuration
. The default isuse_load_balancer_configuration
. -
target_group_health.dns_failover.minimum_healthy_targets.count
- The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values areoff
or an integer from 1 to the maximum number of targets. The default isoff
. -
target_group_health.dns_failover.minimum_healthy_targets.percentage
- The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values areoff
or an integer from 1 to 100. The default isoff
. -
target_group_health.unhealthy_state_routing.minimum_healthy_targets.count
- The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are 1 to the maximum number of targets. The default is 1. -
target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage
- The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values areoff
or an integer from 1 to 100. The default isoff
.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
-
load_balancing.algorithm.type
- The load balancing algorithm determines how the load balancer selects targets when routing requests. The value isround_robin
,least_outstanding_requests
, orweighted_random
. The default isround_robin
. -
load_balancing.algorithm.anomaly_mitigation
- Only available whenload_balancing.algorithm.type
isweighted_random
. Indicates whether anomaly mitigation is enabled. The value ison
oroff
. The default isoff
. -
slow_start.duration_seconds
- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). -
stickiness.app_cookie.cookie_name
- Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed:AWSALB
,AWSALBAPP
, andAWSALBTG
; they're reserved for use by the load balancer. -
stickiness.app_cookie.duration_seconds
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). -
stickiness.lb_cookie.duration_seconds
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
-
lambda.multi_value_headers.enabled
- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value istrue
orfalse
. The default isfalse
. If the value isfalse
and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attributes are supported only by Network Load Balancers:
-
deregistration_delay.connection_termination.enabled
- Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value istrue
orfalse
. For new UDP/TCP_UDP target groups the default istrue
. Otherwise, the default isfalse
. -
preserve_client_ip.enabled
- Indicates whether client IP preservation is enabled. The value istrue
orfalse
. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation can't be disabled for UDP and TCP_UDP target groups. -
proxy_protocol_v2.enabled
- Indicates whether Proxy Protocol version 2 is enabled. The value istrue
orfalse
. The default isfalse
. -
target_health_state.unhealthy.connection_termination.enabled
- Indicates whether the load balancer terminates connections to unhealthy targets. The value istrue
orfalse
. The default istrue
. -
target_health_state.unhealthy.draining_interval_seconds
- The amount of time for Elastic Load Balancing to wait before changing the state of an unhealthy target fromunhealthy.draining
tounhealthy
. The range is 0-360000 seconds. The default value is 0 seconds.Note: This attribute can only be configured when
target_health_state.unhealthy.connection_termination.enabled
isfalse
.
The following attributes are supported only by Gateway Load Balancers:
-
target_failover.on_deregistration
- Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values arerebalance
andno_rebalance
. The default isno_rebalance
. The two attributes (target_failover.on_deregistration
andtarget_failover.on_unhealthy
) can't be set independently. The value you set for both attributes must be the same. -
target_failover.on_unhealthy
- Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values arerebalance
andno_rebalance
. The default isno_rebalance
. The two attributes (target_failover.on_deregistration
andtarget_failover.on_unhealthy
) can't be set independently. The value you set for both attributes must be the same.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9._]+$
Maximum:
256
Update requires: No interruption
-
Value
-
The value of the attribute.
Required: No
Type: String
Update requires: No interruption