com.amazonaws.services.elasticloadbalancingv2.model

Class TargetGroupAttribute

java.lang.Object

com.amazonaws.services.elasticloadbalancingv2.model.TargetGroupAttribute

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TargetGroupAttribute
extends Object
implements Serializable, Cloneable

Information about a target group attribute.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TargetGroupAttribute()

Method Summary

Modifier and Type	Method and Description
TargetGroupAttribute	clone()
boolean	equals(Object obj)
String	getKey() The name of the attribute.
String	getValue() The value of the attribute.
int	hashCode()
void	setKey(String key) The name of the attribute.
void	setValue(String value) The value of the attribute.
String	toString() Returns a string representation of this object.
TargetGroupAttribute	withKey(String key) The name of the attribute.
TargetGroupAttribute	withValue(String value) The value of the attribute.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TargetGroupAttribute

public TargetGroupAttribute()

Method Detail

setKey

public void setKey(String key)

The name of the attribute.

The following attribute is supported by both Application Load Balancers and Network 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.

The following attributes are supported by Application Load Balancers if the target is not a Lambda function:

• slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly 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). Slow start mode is disabled by default.

• stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.

• stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

• 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 target is a Lambda function.

• lambda.multi_value_headers.enabled - Indicates whether the request and response headers 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 attribute is supported only by Network Load Balancers:

• proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

Parameters:

key - The name of the attribute.

The following attribute is supported by both Application Load Balancers and Network 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.

The following attributes are supported by Application Load Balancers if the target is not a Lambda function:

• slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly 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). Slow start mode is disabled by default.

• stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.

• stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

• 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 target is a Lambda function.

• lambda.multi_value_headers.enabled - Indicates whether the request and response headers 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 attribute is supported only by Network Load Balancers:

• proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

getKey

public String getKey()

The name of the attribute.

The following attribute is supported by both Application Load Balancers and Network 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.

The following attributes are supported by Application Load Balancers if the target is not a Lambda function:

• slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly 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). Slow start mode is disabled by default.

• stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.

• stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

• 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 target is a Lambda function.

• lambda.multi_value_headers.enabled - Indicates whether the request and response headers 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 attribute is supported only by Network Load Balancers:

• proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

Returns:

The name of the attribute.

The following attribute is supported by both Application Load Balancers and Network 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.

The following attributes are supported by Application Load Balancers if the target is not a Lambda function:

• slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly 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). Slow start mode is disabled by default.

• stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.

• stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

• 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 target is a Lambda function.

• lambda.multi_value_headers.enabled - Indicates whether the request and response headers 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 attribute is supported only by Network Load Balancers:

• proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

withKey

public TargetGroupAttribute withKey(String key)

The name of the attribute.

The following attribute is supported by both Application Load Balancers and Network 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.

The following attributes are supported by Application Load Balancers if the target is not a Lambda function:

• slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly 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). Slow start mode is disabled by default.

• stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.

• stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

• 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 target is a Lambda function.

• lambda.multi_value_headers.enabled - Indicates whether the request and response headers 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 attribute is supported only by Network Load Balancers:

• proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

Parameters:

key - The name of the attribute.

The following attribute is supported by both Application Load Balancers and Network 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.

The following attributes are supported by Application Load Balancers if the target is not a Lambda function:

• slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly 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). Slow start mode is disabled by default.

• stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.

• stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

• 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 target is a Lambda function.

• lambda.multi_value_headers.enabled - Indicates whether the request and response headers 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 attribute is supported only by Network Load Balancers:

• proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

setValue

public void setValue(String value)

The value of the attribute.

Parameters:

value - The value of the attribute.

getValue

public String getValue()

The value of the attribute.

Returns:

The value of the attribute.

withValue

public TargetGroupAttribute withValue(String value)

The value of the attribute.

Parameters:

value - The value of the attribute.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public TargetGroupAttribute clone()

Overrides:

clone in class Object