com.amazonaws.services.elasticloadbalancingv2.model.TargetGroupAttribute Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticloadbalancingv2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticloadbalancingv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Information about a target group attribute.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TargetGroupAttribute implements Serializable, Cloneable {
/**
*
* 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 from draining to unused. 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 is true
* or false. The default is false.
*
*
* -
*
* stickiness.type - Indicates the type of stickiness. The possible values are:
*
*
* -
*
* lb_cookie and app_cookie for Application Load Balancers.
*
*
* -
*
* source_ip for Network Load Balancers.
*
*
* -
*
* source_ip_dest_ip and source_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 is true, false or use_load_balancer_configuration. The default is
* use_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 are off or an integer from 1 to the
* maximum number of targets. The default is off.
*
*
* -
*
* 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 are off or an
* integer from 1 to 100. The default is off.
*
*
* -
*
* 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 are off or an integer from
* 1 to 100. The default is off.
*
*
*
*
* 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 is round_robin,
* least_outstanding_requests, or weighted_random. The default is round_robin
* .
*
*
* -
*
* load_balancing.algorithm.anomaly_mitigation - Only available when
* load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation
* is enabled. The value is on or off. The default is off.
*
*
* -
*
* 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, and
* AWSALBTG; 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 is
* true or false. The default is false. If the value is false
* 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 is true or false. For
* new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false.
*
*
* -
*
* preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is
* true or false. 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 cannot be disabled
* for UDP and TCP_UDP target groups.
*
*
* -
*
* proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is
* true or false. The default is false.
*
*
* -
*
* target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer
* terminates connections to unhealthy targets. The value is true or false. The default is
* true.
*
*
* -
*
* 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 from unhealthy.draining to
* unhealthy. 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 is false.
*
*
*
*
* 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 are rebalance and no_rebalance. The
* default is no_rebalance. The two attributes (target_failover.on_deregistration and
* target_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 are rebalance and no_rebalance. The default is
* no_rebalance. The two attributes (target_failover.on_deregistration and
* target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes
* must be the same.
*
*
*
*/
private String key;
/**
*
* The value of the attribute.
*
*/
private String value;
/**
*
* 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 from draining to unused. 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 is true
* or false. The default is false.
*
*
* -
*
* stickiness.type - Indicates the type of stickiness. The possible values are:
*
*
* -
*
* lb_cookie and app_cookie for Application Load Balancers.
*
*
* -
*
* source_ip for Network Load Balancers.
*
*
* -
*
* source_ip_dest_ip and source_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 is true, false or use_load_balancer_configuration. The default is
* use_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 are off or an integer from 1 to the
* maximum number of targets. The default is off.
*
*
* -
*
* 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 are off or an
* integer from 1 to 100. The default is off.
*
*
* -
*
* 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 are off or an integer from
* 1 to 100. The default is off.
*
*
*
*
* 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 is round_robin,
* least_outstanding_requests, or weighted_random. The default is round_robin
* .
*
*
* -
*
* load_balancing.algorithm.anomaly_mitigation - Only available when
* load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation
* is enabled. The value is on or off. The default is off.
*
*
* -
*
* 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, and
* AWSALBTG; 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 is
* true or false. The default is false. If the value is false
* 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 is true or false. For
* new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false.
*
*
* -
*
* preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is
* true or false. 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 cannot be disabled
* for UDP and TCP_UDP target groups.
*
*
* -
*
* proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is
* true or false. The default is false.
*
*
* -
*
* target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer
* terminates connections to unhealthy targets. The value is true or false. The default is
* true.
*
*
* -
*
* 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 from unhealthy.draining to
* unhealthy. 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 is false.
*
*
*
*
* 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 are rebalance and no_rebalance. The
* default is no_rebalance. The two attributes (target_failover.on_deregistration and
* target_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 are rebalance and no_rebalance. The default is
* no_rebalance. The two attributes (target_failover.on_deregistration and
* target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes
* must be the same.
*
*
*
*
* @param 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 from draining to
* unused. 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 is
* true or false. The default is false.
*
*
* -
*
* stickiness.type - Indicates the type of stickiness. The possible values are:
*
*
* -
*
* lb_cookie and app_cookie for Application Load Balancers.
*
*
* -
*
* source_ip for Network Load Balancers.
*
*
* -
*
* source_ip_dest_ip and source_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 is true, false or use_load_balancer_configuration. The
* default is use_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 are
* off or an integer from 1 to the maximum number of targets. The default is off.
*
*
* -
*
* 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 are
* off or an integer from 1 to 100. The default is off.
*
*
* -
*
* 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 are off or an
* integer from 1 to 100. The default is off.
*
*
*
*
* 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 is round_robin,
* least_outstanding_requests, or weighted_random. The default is
* round_robin.
*
*
* -
*
* load_balancing.algorithm.anomaly_mitigation - Only available when
* load_balancing.algorithm.type is weighted_random. Indicates whether anomaly
* mitigation is enabled. The value is on or off. The default is off.
*
*
* -
*
* 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, and
* AWSALBTG; 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 is true or false. The default is false. If the value is
* false 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 is true or
* false. For new UDP/TCP_UDP target groups the default is true. Otherwise, the
* default is false.
*
*
* -
*
* preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value
* is true or false. 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
* cannot be disabled for UDP and TCP_UDP target groups.
*
*
* -
*
* proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value
* is true or false. The default is false.
*
*
* -
*
* target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load
* balancer terminates connections to unhealthy targets. The value is true or false
* . The default is true.
*
*
* -
*
* 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 from unhealthy.draining to
* unhealthy. 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 is false.
*
*
*
*
* 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 are rebalance and
* no_rebalance. The default is no_rebalance. The two attributes (
* target_failover.on_deregistration and target_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 are rebalance and no_rebalance.
* The default is no_rebalance. The two attributes (
* target_failover.on_deregistration and target_failover.on_unhealthy) cannot be
* set independently. The value you set for both attributes must be the same.
*
*
*/
public void setKey(String key) {
this.key = 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 from draining to unused. 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 is true
* or false. The default is false.
*
*
* -
*
* stickiness.type - Indicates the type of stickiness. The possible values are:
*
*
* -
*
* lb_cookie and app_cookie for Application Load Balancers.
*
*
* -
*
* source_ip for Network Load Balancers.
*
*
* -
*
* source_ip_dest_ip and source_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 is true, false or use_load_balancer_configuration. The default is
* use_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 are off or an integer from 1 to the
* maximum number of targets. The default is off.
*
*
* -
*
* 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 are off or an
* integer from 1 to 100. The default is off.
*
*
* -
*
* 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 are off or an integer from
* 1 to 100. The default is off.
*
*
*
*
* 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 is round_robin,
* least_outstanding_requests, or weighted_random. The default is round_robin
* .
*
*
* -
*
* load_balancing.algorithm.anomaly_mitigation - Only available when
* load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation
* is enabled. The value is on or off. The default is off.
*
*
* -
*
* 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, and
* AWSALBTG; 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 is
* true or false. The default is false. If the value is false
* 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 is true or false. For
* new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false.
*
*
* -
*
* preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is
* true or false. 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 cannot be disabled
* for UDP and TCP_UDP target groups.
*
*
* -
*
* proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is
* true or false. The default is false.
*
*
* -
*
* target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer
* terminates connections to unhealthy targets. The value is true or false. The default is
* true.
*
*
* -
*
* 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 from unhealthy.draining to
* unhealthy. 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 is false.
*
*
*
*
* 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 are rebalance and no_rebalance. The
* default is no_rebalance. The two attributes (target_failover.on_deregistration and
* target_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 are rebalance and no_rebalance. The default is
* no_rebalance. The two attributes (target_failover.on_deregistration and
* target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes
* must be the same.
*
*
*
*
* @return 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 from draining to
* unused. 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 is
* true or false. The default is false.
*
*
* -
*
* stickiness.type - Indicates the type of stickiness. The possible values are:
*
*
* -
*
* lb_cookie and app_cookie for Application Load Balancers.
*
*
* -
*
* source_ip for Network Load Balancers.
*
*
* -
*
* source_ip_dest_ip and source_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 is true, false or use_load_balancer_configuration. The
* default is use_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 are
* off or an integer from 1 to the maximum number of targets. The default is off.
*
*
* -
*
* 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 are
* off or an integer from 1 to 100. The default is off.
*
*
* -
*
* 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 are off or an
* integer from 1 to 100. The default is off.
*
*
*
*
* 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 is round_robin,
* least_outstanding_requests, or weighted_random. The default is
* round_robin.
*
*
* -
*
* load_balancing.algorithm.anomaly_mitigation - Only available when
* load_balancing.algorithm.type is weighted_random. Indicates whether anomaly
* mitigation is enabled. The value is on or off. The default is off.
*
*
* -
*
* 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
* , and AWSALBTG; 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 is true or false. The default is false. If the value is
* false 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 is true or
* false. For new UDP/TCP_UDP target groups the default is true. Otherwise, the
* default is false.
*
*
* -
*
* preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value
* is true or false. 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 cannot be disabled for UDP and TCP_UDP target groups.
*
*
* -
*
* proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value
* is true or false. The default is false.
*
*
* -
*
* target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load
* balancer terminates connections to unhealthy targets. The value is true or
* false. The default is true.
*
*
* -
*
* 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 from
* unhealthy.draining to unhealthy. 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 is false.
*
*
*
*
* 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 are rebalance and
* no_rebalance. The default is no_rebalance. The two attributes (
* target_failover.on_deregistration and target_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 are rebalance and
* no_rebalance. The default is no_rebalance. The two attributes (
* target_failover.on_deregistration and target_failover.on_unhealthy) cannot be
* set independently. The value you set for both attributes must be the same.
*
*
*/
public String getKey() {
return this.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 from draining to unused. 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 is true
* or false. The default is false.
*
*
* -
*
* stickiness.type - Indicates the type of stickiness. The possible values are:
*
*
* -
*
* lb_cookie and app_cookie for Application Load Balancers.
*
*
* -
*
* source_ip for Network Load Balancers.
*
*
* -
*
* source_ip_dest_ip and source_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 is true, false or use_load_balancer_configuration. The default is
* use_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 are off or an integer from 1 to the
* maximum number of targets. The default is off.
*
*
* -
*
* 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 are off or an
* integer from 1 to 100. The default is off.
*
*
* -
*
* 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 are off or an integer from
* 1 to 100. The default is off.
*
*
*
*
* 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 is round_robin,
* least_outstanding_requests, or weighted_random. The default is round_robin
* .
*
*
* -
*
* load_balancing.algorithm.anomaly_mitigation - Only available when
* load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation
* is enabled. The value is on or off. The default is off.
*
*
* -
*
* 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, and
* AWSALBTG; 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 is
* true or false. The default is false. If the value is false
* 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 is true or false. For
* new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false.
*
*
* -
*
* preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is
* true or false. 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 cannot be disabled
* for UDP and TCP_UDP target groups.
*
*
* -
*
* proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is
* true or false. The default is false.
*
*
* -
*
* target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer
* terminates connections to unhealthy targets. The value is true or false. The default is
* true.
*
*
* -
*
* 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 from unhealthy.draining to
* unhealthy. 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 is false.
*
*
*
*
* 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 are rebalance and no_rebalance. The
* default is no_rebalance. The two attributes (target_failover.on_deregistration and
* target_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 are rebalance and no_rebalance. The default is
* no_rebalance. The two attributes (target_failover.on_deregistration and
* target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes
* must be the same.
*
*
*
*
* @param 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 from draining to
* unused. 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 is
* true or false. The default is false.
*
*
* -
*
* stickiness.type - Indicates the type of stickiness. The possible values are:
*
*
* -
*
* lb_cookie and app_cookie for Application Load Balancers.
*
*
* -
*
* source_ip for Network Load Balancers.
*
*
* -
*
* source_ip_dest_ip and source_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 is true, false or use_load_balancer_configuration. The
* default is use_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 are
* off or an integer from 1 to the maximum number of targets. The default is off.
*
*
* -
*
* 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 are
* off or an integer from 1 to 100. The default is off.
*
*
* -
*
* 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 are off or an
* integer from 1 to 100. The default is off.
*
*
*
*
* 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 is round_robin,
* least_outstanding_requests, or weighted_random. The default is
* round_robin.
*
*
* -
*
* load_balancing.algorithm.anomaly_mitigation - Only available when
* load_balancing.algorithm.type is weighted_random. Indicates whether anomaly
* mitigation is enabled. The value is on or off. The default is off.
*
*
* -
*
* 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, and
* AWSALBTG; 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 is true or false. The default is false. If the value is
* false 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 is true or
* false. For new UDP/TCP_UDP target groups the default is true. Otherwise, the
* default is false.
*
*
* -
*
* preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value
* is true or false. 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
* cannot be disabled for UDP and TCP_UDP target groups.
*
*
* -
*
* proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value
* is true or false. The default is false.
*
*
* -
*
* target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load
* balancer terminates connections to unhealthy targets. The value is true or false
* . The default is true.
*
*
* -
*
* 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 from unhealthy.draining to
* unhealthy. 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 is false.
*
*
*
*
* 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 are rebalance and
* no_rebalance. The default is no_rebalance. The two attributes (
* target_failover.on_deregistration and target_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 are rebalance and no_rebalance.
* The default is no_rebalance. The two attributes (
* target_failover.on_deregistration and target_failover.on_unhealthy) cannot be
* set independently. The value you set for both attributes must be the same.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TargetGroupAttribute withKey(String key) {
setKey(key);
return this;
}
/**
*
* The value of the attribute.
*
*
* @param value
* The value of the attribute.
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* The value of the attribute.
*
*
* @return The value of the attribute.
*/
public String getValue() {
return this.value;
}
/**
*
* The value of the attribute.
*
*
* @param value
* The value of the attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TargetGroupAttribute withValue(String value) {
setValue(value);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getKey() != null)
sb.append("Key: ").append(getKey()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TargetGroupAttribute == false)
return false;
TargetGroupAttribute other = (TargetGroupAttribute) obj;
if (other.getKey() == null ^ this.getKey() == null)
return false;
if (other.getKey() != null && other.getKey().equals(this.getKey()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
return hashCode;
}
@Override
public TargetGroupAttribute clone() {
try {
return (TargetGroupAttribute) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}