@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TargetGroup extends Object implements Serializable, Cloneable
Information about a target group.
Constructor and Description |
---|
TargetGroup() |
Modifier and Type | Method and Description |
---|---|
TargetGroup |
clone() |
boolean |
equals(Object obj) |
Boolean |
getHealthCheckEnabled()
Indicates whether health checks are enabled.
|
Integer |
getHealthCheckIntervalSeconds()
The approximate amount of time, in seconds, between health checks of an individual target.
|
String |
getHealthCheckPath()
The destination for health checks on the targets.
|
String |
getHealthCheckPort()
The port to use to connect with the target.
|
String |
getHealthCheckProtocol()
The protocol to use to connect with the target.
|
Integer |
getHealthCheckTimeoutSeconds()
The amount of time, in seconds, during which no response means a failed health check.
|
Integer |
getHealthyThresholdCount()
The number of consecutive health checks successes required before considering an unhealthy target healthy.
|
String |
getIpAddressType()
The type of IP address used for this target group.
|
List<String> |
getLoadBalancerArns()
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.
|
Matcher |
getMatcher()
The HTTP or gRPC codes to use when checking for a successful response from a target.
|
Integer |
getPort()
The port on which the targets are listening.
|
String |
getProtocol()
The protocol to use for routing traffic to the targets.
|
String |
getProtocolVersion()
[HTTP/HTTPS protocol] The protocol version.
|
String |
getTargetGroupArn()
The Amazon Resource Name (ARN) of the target group.
|
String |
getTargetGroupName()
The name of the target group.
|
String |
getTargetType()
The type of target that you must specify when registering targets with this target group.
|
Integer |
getUnhealthyThresholdCount()
The number of consecutive health check failures required before considering the target unhealthy.
|
String |
getVpcId()
The ID of the VPC for the targets.
|
int |
hashCode() |
Boolean |
isHealthCheckEnabled()
Indicates whether health checks are enabled.
|
void |
setHealthCheckEnabled(Boolean healthCheckEnabled)
Indicates whether health checks are enabled.
|
void |
setHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)
The approximate amount of time, in seconds, between health checks of an individual target.
|
void |
setHealthCheckPath(String healthCheckPath)
The destination for health checks on the targets.
|
void |
setHealthCheckPort(String healthCheckPort)
The port to use to connect with the target.
|
void |
setHealthCheckProtocol(ProtocolEnum healthCheckProtocol)
The protocol to use to connect with the target.
|
void |
setHealthCheckProtocol(String healthCheckProtocol)
The protocol to use to connect with the target.
|
void |
setHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)
The amount of time, in seconds, during which no response means a failed health check.
|
void |
setHealthyThresholdCount(Integer healthyThresholdCount)
The number of consecutive health checks successes required before considering an unhealthy target healthy.
|
void |
setIpAddressType(String ipAddressType)
The type of IP address used for this target group.
|
void |
setIpAddressType(TargetGroupIpAddressTypeEnum ipAddressType)
The type of IP address used for this target group.
|
void |
setLoadBalancerArns(Collection<String> loadBalancerArns)
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.
|
void |
setMatcher(Matcher matcher)
The HTTP or gRPC codes to use when checking for a successful response from a target.
|
void |
setPort(Integer port)
The port on which the targets are listening.
|
void |
setProtocol(ProtocolEnum protocol)
The protocol to use for routing traffic to the targets.
|
void |
setProtocol(String protocol)
The protocol to use for routing traffic to the targets.
|
void |
setProtocolVersion(String protocolVersion)
[HTTP/HTTPS protocol] The protocol version.
|
void |
setTargetGroupArn(String targetGroupArn)
The Amazon Resource Name (ARN) of the target group.
|
void |
setTargetGroupName(String targetGroupName)
The name of the target group.
|
void |
setTargetType(String targetType)
The type of target that you must specify when registering targets with this target group.
|
void |
setTargetType(TargetTypeEnum targetType)
The type of target that you must specify when registering targets with this target group.
|
void |
setUnhealthyThresholdCount(Integer unhealthyThresholdCount)
The number of consecutive health check failures required before considering the target unhealthy.
|
void |
setVpcId(String vpcId)
The ID of the VPC for the targets.
|
String |
toString()
Returns a string representation of this object.
|
TargetGroup |
withHealthCheckEnabled(Boolean healthCheckEnabled)
Indicates whether health checks are enabled.
|
TargetGroup |
withHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)
The approximate amount of time, in seconds, between health checks of an individual target.
|
TargetGroup |
withHealthCheckPath(String healthCheckPath)
The destination for health checks on the targets.
|
TargetGroup |
withHealthCheckPort(String healthCheckPort)
The port to use to connect with the target.
|
TargetGroup |
withHealthCheckProtocol(ProtocolEnum healthCheckProtocol)
The protocol to use to connect with the target.
|
TargetGroup |
withHealthCheckProtocol(String healthCheckProtocol)
The protocol to use to connect with the target.
|
TargetGroup |
withHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)
The amount of time, in seconds, during which no response means a failed health check.
|
TargetGroup |
withHealthyThresholdCount(Integer healthyThresholdCount)
The number of consecutive health checks successes required before considering an unhealthy target healthy.
|
TargetGroup |
withIpAddressType(String ipAddressType)
The type of IP address used for this target group.
|
TargetGroup |
withIpAddressType(TargetGroupIpAddressTypeEnum ipAddressType)
The type of IP address used for this target group.
|
TargetGroup |
withLoadBalancerArns(Collection<String> loadBalancerArns)
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.
|
TargetGroup |
withLoadBalancerArns(String... loadBalancerArns)
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.
|
TargetGroup |
withMatcher(Matcher matcher)
The HTTP or gRPC codes to use when checking for a successful response from a target.
|
TargetGroup |
withPort(Integer port)
The port on which the targets are listening.
|
TargetGroup |
withProtocol(ProtocolEnum protocol)
The protocol to use for routing traffic to the targets.
|
TargetGroup |
withProtocol(String protocol)
The protocol to use for routing traffic to the targets.
|
TargetGroup |
withProtocolVersion(String protocolVersion)
[HTTP/HTTPS protocol] The protocol version.
|
TargetGroup |
withTargetGroupArn(String targetGroupArn)
The Amazon Resource Name (ARN) of the target group.
|
TargetGroup |
withTargetGroupName(String targetGroupName)
The name of the target group.
|
TargetGroup |
withTargetType(String targetType)
The type of target that you must specify when registering targets with this target group.
|
TargetGroup |
withTargetType(TargetTypeEnum targetType)
The type of target that you must specify when registering targets with this target group.
|
TargetGroup |
withUnhealthyThresholdCount(Integer unhealthyThresholdCount)
The number of consecutive health check failures required before considering the target unhealthy.
|
TargetGroup |
withVpcId(String vpcId)
The ID of the VPC for the targets.
|
public void setTargetGroupArn(String targetGroupArn)
The Amazon Resource Name (ARN) of the target group.
targetGroupArn
- The Amazon Resource Name (ARN) of the target group.public String getTargetGroupArn()
The Amazon Resource Name (ARN) of the target group.
public TargetGroup withTargetGroupArn(String targetGroupArn)
The Amazon Resource Name (ARN) of the target group.
targetGroupArn
- The Amazon Resource Name (ARN) of the target group.public void setTargetGroupName(String targetGroupName)
The name of the target group.
targetGroupName
- The name of the target group.public String getTargetGroupName()
The name of the target group.
public TargetGroup withTargetGroupName(String targetGroupName)
The name of the target group.
targetGroupName
- The name of the target group.public void setProtocol(String protocol)
The protocol to use for routing traffic to the targets.
protocol
- The protocol to use for routing traffic to the targets.ProtocolEnum
public String getProtocol()
The protocol to use for routing traffic to the targets.
ProtocolEnum
public TargetGroup withProtocol(String protocol)
The protocol to use for routing traffic to the targets.
protocol
- The protocol to use for routing traffic to the targets.ProtocolEnum
public void setProtocol(ProtocolEnum protocol)
The protocol to use for routing traffic to the targets.
protocol
- The protocol to use for routing traffic to the targets.ProtocolEnum
public TargetGroup withProtocol(ProtocolEnum protocol)
The protocol to use for routing traffic to the targets.
protocol
- The protocol to use for routing traffic to the targets.ProtocolEnum
public void setPort(Integer port)
The port on which the targets are listening. This parameter is not used if the target is a Lambda function.
port
- The port on which the targets are listening. This parameter is not used if the target is a Lambda
function.public Integer getPort()
The port on which the targets are listening. This parameter is not used if the target is a Lambda function.
public TargetGroup withPort(Integer port)
The port on which the targets are listening. This parameter is not used if the target is a Lambda function.
port
- The port on which the targets are listening. This parameter is not used if the target is a Lambda
function.public void setVpcId(String vpcId)
The ID of the VPC for the targets.
vpcId
- The ID of the VPC for the targets.public String getVpcId()
The ID of the VPC for the targets.
public TargetGroup withVpcId(String vpcId)
The ID of the VPC for the targets.
vpcId
- The ID of the VPC for the targets.public void setHealthCheckProtocol(String healthCheckProtocol)
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
healthCheckProtocol
- The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not
supported for health checks.ProtocolEnum
public String getHealthCheckProtocol()
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
ProtocolEnum
public TargetGroup withHealthCheckProtocol(String healthCheckProtocol)
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
healthCheckProtocol
- The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not
supported for health checks.ProtocolEnum
public void setHealthCheckProtocol(ProtocolEnum healthCheckProtocol)
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
healthCheckProtocol
- The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not
supported for health checks.ProtocolEnum
public TargetGroup withHealthCheckProtocol(ProtocolEnum healthCheckProtocol)
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
healthCheckProtocol
- The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not
supported for health checks.ProtocolEnum
public void setHealthCheckPort(String healthCheckPort)
The port to use to connect with the target.
healthCheckPort
- The port to use to connect with the target.public String getHealthCheckPort()
The port to use to connect with the target.
public TargetGroup withHealthCheckPort(String healthCheckPort)
The port to use to connect with the target.
healthCheckPort
- The port to use to connect with the target.public void setHealthCheckEnabled(Boolean healthCheckEnabled)
Indicates whether health checks are enabled.
healthCheckEnabled
- Indicates whether health checks are enabled.public Boolean getHealthCheckEnabled()
Indicates whether health checks are enabled.
public TargetGroup withHealthCheckEnabled(Boolean healthCheckEnabled)
Indicates whether health checks are enabled.
healthCheckEnabled
- Indicates whether health checks are enabled.public Boolean isHealthCheckEnabled()
Indicates whether health checks are enabled.
public void setHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)
The approximate amount of time, in seconds, between health checks of an individual target.
healthCheckIntervalSeconds
- The approximate amount of time, in seconds, between health checks of an individual target.public Integer getHealthCheckIntervalSeconds()
The approximate amount of time, in seconds, between health checks of an individual target.
public TargetGroup withHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)
The approximate amount of time, in seconds, between health checks of an individual target.
healthCheckIntervalSeconds
- The approximate amount of time, in seconds, between health checks of an individual target.public void setHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)
The amount of time, in seconds, during which no response means a failed health check.
healthCheckTimeoutSeconds
- The amount of time, in seconds, during which no response means a failed health check.public Integer getHealthCheckTimeoutSeconds()
The amount of time, in seconds, during which no response means a failed health check.
public TargetGroup withHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)
The amount of time, in seconds, during which no response means a failed health check.
healthCheckTimeoutSeconds
- The amount of time, in seconds, during which no response means a failed health check.public void setHealthyThresholdCount(Integer healthyThresholdCount)
The number of consecutive health checks successes required before considering an unhealthy target healthy.
healthyThresholdCount
- The number of consecutive health checks successes required before considering an unhealthy target healthy.public Integer getHealthyThresholdCount()
The number of consecutive health checks successes required before considering an unhealthy target healthy.
public TargetGroup withHealthyThresholdCount(Integer healthyThresholdCount)
The number of consecutive health checks successes required before considering an unhealthy target healthy.
healthyThresholdCount
- The number of consecutive health checks successes required before considering an unhealthy target healthy.public void setUnhealthyThresholdCount(Integer unhealthyThresholdCount)
The number of consecutive health check failures required before considering the target unhealthy.
unhealthyThresholdCount
- The number of consecutive health check failures required before considering the target unhealthy.public Integer getUnhealthyThresholdCount()
The number of consecutive health check failures required before considering the target unhealthy.
public TargetGroup withUnhealthyThresholdCount(Integer unhealthyThresholdCount)
The number of consecutive health check failures required before considering the target unhealthy.
unhealthyThresholdCount
- The number of consecutive health check failures required before considering the target unhealthy.public void setHealthCheckPath(String healthCheckPath)
The destination for health checks on the targets.
healthCheckPath
- The destination for health checks on the targets.public String getHealthCheckPath()
The destination for health checks on the targets.
public TargetGroup withHealthCheckPath(String healthCheckPath)
The destination for health checks on the targets.
healthCheckPath
- The destination for health checks on the targets.public void setMatcher(Matcher matcher)
The HTTP or gRPC codes to use when checking for a successful response from a target.
matcher
- The HTTP or gRPC codes to use when checking for a successful response from a target.public Matcher getMatcher()
The HTTP or gRPC codes to use when checking for a successful response from a target.
public TargetGroup withMatcher(Matcher matcher)
The HTTP or gRPC codes to use when checking for a successful response from a target.
matcher
- The HTTP or gRPC codes to use when checking for a successful response from a target.public List<String> getLoadBalancerArns()
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.
public void setLoadBalancerArns(Collection<String> loadBalancerArns)
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.
loadBalancerArns
- The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use
each target group with only one load balancer.public TargetGroup withLoadBalancerArns(String... loadBalancerArns)
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.
NOTE: This method appends the values to the existing list (if any). Use
setLoadBalancerArns(java.util.Collection)
or withLoadBalancerArns(java.util.Collection)
if you
want to override the existing values.
loadBalancerArns
- The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use
each target group with only one load balancer.public TargetGroup withLoadBalancerArns(Collection<String> loadBalancerArns)
The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.
loadBalancerArns
- The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use
each target group with only one load balancer.public void setTargetType(String targetType)
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(register targets by instance ID), ip
(register targets by IP address),
lambda
(register a single Lambda function as a target), or alb
(register a single
Application Load Balancer as a target).
targetType
- The type of target that you must specify when registering targets with this target group. The possible
values are instance
(register targets by instance ID), ip
(register targets by
IP address), lambda
(register a single Lambda function as a target), or alb
(register a single Application Load Balancer as a target).TargetTypeEnum
public String getTargetType()
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(register targets by instance ID), ip
(register targets by IP address),
lambda
(register a single Lambda function as a target), or alb
(register a single
Application Load Balancer as a target).
instance
(register targets by instance ID), ip
(register targets by
IP address), lambda
(register a single Lambda function as a target), or alb
(register a single Application Load Balancer as a target).TargetTypeEnum
public TargetGroup withTargetType(String targetType)
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(register targets by instance ID), ip
(register targets by IP address),
lambda
(register a single Lambda function as a target), or alb
(register a single
Application Load Balancer as a target).
targetType
- The type of target that you must specify when registering targets with this target group. The possible
values are instance
(register targets by instance ID), ip
(register targets by
IP address), lambda
(register a single Lambda function as a target), or alb
(register a single Application Load Balancer as a target).TargetTypeEnum
public void setTargetType(TargetTypeEnum targetType)
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(register targets by instance ID), ip
(register targets by IP address),
lambda
(register a single Lambda function as a target), or alb
(register a single
Application Load Balancer as a target).
targetType
- The type of target that you must specify when registering targets with this target group. The possible
values are instance
(register targets by instance ID), ip
(register targets by
IP address), lambda
(register a single Lambda function as a target), or alb
(register a single Application Load Balancer as a target).TargetTypeEnum
public TargetGroup withTargetType(TargetTypeEnum targetType)
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(register targets by instance ID), ip
(register targets by IP address),
lambda
(register a single Lambda function as a target), or alb
(register a single
Application Load Balancer as a target).
targetType
- The type of target that you must specify when registering targets with this target group. The possible
values are instance
(register targets by instance ID), ip
(register targets by
IP address), lambda
(register a single Lambda function as a target), or alb
(register a single Application Load Balancer as a target).TargetTypeEnum
public void setProtocolVersion(String protocolVersion)
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC
, HTTP1
, and
HTTP2
.
protocolVersion
- [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC
, HTTP1
,
and HTTP2
.public String getProtocolVersion()
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC
, HTTP1
, and
HTTP2
.
GRPC
, HTTP1
, and HTTP2
.public TargetGroup withProtocolVersion(String protocolVersion)
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC
, HTTP1
, and
HTTP2
.
protocolVersion
- [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC
, HTTP1
,
and HTTP2
.public void setIpAddressType(String ipAddressType)
The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.
ipAddressType
- The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.TargetGroupIpAddressTypeEnum
public String getIpAddressType()
The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.
ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.TargetGroupIpAddressTypeEnum
public TargetGroup withIpAddressType(String ipAddressType)
The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.
ipAddressType
- The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.TargetGroupIpAddressTypeEnum
public void setIpAddressType(TargetGroupIpAddressTypeEnum ipAddressType)
The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.
ipAddressType
- The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.TargetGroupIpAddressTypeEnum
public TargetGroup withIpAddressType(TargetGroupIpAddressTypeEnum ipAddressType)
The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.
ipAddressType
- The type of IP address used for this target group. The possible values are ipv4
and
ipv6
. This is an optional parameter. If not specified, the IP address type defaults to
ipv4
.TargetGroupIpAddressTypeEnum
public String toString()
toString
in class Object
Object.toString()
public TargetGroup clone()