TargetGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticloadbalancingv2.model.TargetGroup

All Implemented Interfaces:: Serializable, Cloneable

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

Information about a target group.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TargetGroup()

Constructors
Constructor and Description
`TargetGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TargetGroup`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getHealthCheckIntervalSeconds()` The approximate amount of time, in seconds, between health checks of an individual target.
`String`	`getHealthCheckPath()` The destination for the health check request.
`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.
`List<String>`	`getLoadBalancerArns()` The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
`Matcher`	`getMatcher()` The HTTP 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`	`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()`
`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 the health check request.
`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`	`setLoadBalancerArns(Collection<String> loadBalancerArns)` The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
`void`	`setMatcher(Matcher matcher)` The HTTP 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`	`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; useful for testing and debugging.
`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 the health check request.
`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`	`withLoadBalancerArns(Collection<String> loadBalancerArns)` The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
`TargetGroup`	`withLoadBalancerArns(String... loadBalancerArns)` The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
`TargetGroup`	`withMatcher(Matcher matcher)` The HTTP 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`	`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TargetGroup
```
public TargetGroup()
```
- Method Detail
  - setTargetGroupArn
```
public void setTargetGroupArn(String targetGroupArn)
```
    The Amazon Resource Name (ARN) of the target group.
    
    Parameters:
    
    targetGroupArn - The Amazon Resource Name (ARN) of the target group.
  - getTargetGroupArn
```
public String getTargetGroupArn()
```
    The Amazon Resource Name (ARN) of the target group.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the target group.
  - withTargetGroupArn
```
public TargetGroup withTargetGroupArn(String targetGroupArn)
```
    The Amazon Resource Name (ARN) of the target group.
    
    Parameters:
    
    targetGroupArn - The Amazon Resource Name (ARN) of the target group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetGroupName
```
public void setTargetGroupName(String targetGroupName)
```
    The name of the target group.
    
    Parameters:
    
    targetGroupName - The name of the target group.
  - getTargetGroupName
```
public String getTargetGroupName()
```
    The name of the target group.
    
    Returns:
    
    The name of the target group.
  - withTargetGroupName
```
public TargetGroup withTargetGroupName(String targetGroupName)
```
    The name of the target group.
    
    Parameters:
    
    targetGroupName - The name of the target group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The protocol to use for routing traffic to the targets.
    
    Parameters:
    
    protocol - The protocol to use for routing traffic to the targets.
    
    See Also:
    
    ProtocolEnum
  - getProtocol
```
public String getProtocol()
```
    The protocol to use for routing traffic to the targets.
    
    Returns:
    
    The protocol to use for routing traffic to the targets.
    
    See Also:
    
    ProtocolEnum
  - withProtocol
```
public TargetGroup withProtocol(String protocol)
```
    The protocol to use for routing traffic to the targets.
    
    Parameters:
    
    protocol - The protocol to use for routing traffic to the targets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtocolEnum
  - setProtocol
```
public void setProtocol(ProtocolEnum protocol)
```
    The protocol to use for routing traffic to the targets.
    
    Parameters:
    
    protocol - The protocol to use for routing traffic to the targets.
    
    See Also:
    
    ProtocolEnum
  - withProtocol
```
public TargetGroup withProtocol(ProtocolEnum protocol)
```
    The protocol to use for routing traffic to the targets.
    
    Parameters:
    
    protocol - The protocol to use for routing traffic to the targets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtocolEnum
  - setPort
```
public void setPort(Integer port)
```
    The port on which the targets are listening.
    
    Parameters:
    
    port - The port on which the targets are listening.
  - getPort
```
public Integer getPort()
```
    The port on which the targets are listening.
    
    Returns:
    
    The port on which the targets are listening.
  - withPort
```
public TargetGroup withPort(Integer port)
```
    The port on which the targets are listening.
    
    Parameters:
    
    port - The port on which the targets are listening.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcId
```
public void setVpcId(String vpcId)
```
    The ID of the VPC for the targets.
    
    Parameters:
    
    vpcId - The ID of the VPC for the targets.
  - getVpcId
```
public String getVpcId()
```
    The ID of the VPC for the targets.
    
    Returns:
    
    The ID of the VPC for the targets.
  - withVpcId
```
public TargetGroup withVpcId(String vpcId)
```
    The ID of the VPC for the targets.
    
    Parameters:
    
    vpcId - The ID of the VPC for the targets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthCheckProtocol
```
public void setHealthCheckProtocol(String healthCheckProtocol)
```
    The protocol to use to connect with the target.
    
    Parameters:
    
    healthCheckProtocol - The protocol to use to connect with the target.
    
    See Also:
    
    ProtocolEnum
  - getHealthCheckProtocol
```
public String getHealthCheckProtocol()
```
    The protocol to use to connect with the target.
    
    Returns:
    
    The protocol to use to connect with the target.
    
    See Also:
    
    ProtocolEnum
  - withHealthCheckProtocol
```
public TargetGroup withHealthCheckProtocol(String healthCheckProtocol)
```
    The protocol to use to connect with the target.
    
    Parameters:
    
    healthCheckProtocol - The protocol to use to connect with the target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtocolEnum
  - setHealthCheckProtocol
```
public void setHealthCheckProtocol(ProtocolEnum healthCheckProtocol)
```
    The protocol to use to connect with the target.
    
    Parameters:
    
    healthCheckProtocol - The protocol to use to connect with the target.
    
    See Also:
    
    ProtocolEnum
  - withHealthCheckProtocol
```
public TargetGroup withHealthCheckProtocol(ProtocolEnum healthCheckProtocol)
```
    The protocol to use to connect with the target.
    
    Parameters:
    
    healthCheckProtocol - The protocol to use to connect with the target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtocolEnum
  - setHealthCheckPort
```
public void setHealthCheckPort(String healthCheckPort)
```
    The port to use to connect with the target.
    
    Parameters:
    
    healthCheckPort - The port to use to connect with the target.
  - getHealthCheckPort
```
public String getHealthCheckPort()
```
    The port to use to connect with the target.
    
    Returns:
    
    The port to use to connect with the target.
  - withHealthCheckPort
```
public TargetGroup withHealthCheckPort(String healthCheckPort)
```
    The port to use to connect with the target.
    
    Parameters:
    
    healthCheckPort - The port to use to connect with the target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthCheckIntervalSeconds
```
public void setHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)
```
    The approximate amount of time, in seconds, between health checks of an individual target.
    
    Parameters:
    
    healthCheckIntervalSeconds - The approximate amount of time, in seconds, between health checks of an individual target.
  - getHealthCheckIntervalSeconds
```
public Integer getHealthCheckIntervalSeconds()
```
    The approximate amount of time, in seconds, between health checks of an individual target.
    
    Returns:
    
    The approximate amount of time, in seconds, between health checks of an individual target.
  - withHealthCheckIntervalSeconds
```
public TargetGroup withHealthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)
```
    The approximate amount of time, in seconds, between health checks of an individual target.
    
    Parameters:
    
    healthCheckIntervalSeconds - The approximate amount of time, in seconds, between health checks of an individual target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthCheckTimeoutSeconds
```
public void setHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)
```
    The amount of time, in seconds, during which no response means a failed health check.
    
    Parameters:
    
    healthCheckTimeoutSeconds - The amount of time, in seconds, during which no response means a failed health check.
  - getHealthCheckTimeoutSeconds
```
public Integer getHealthCheckTimeoutSeconds()
```
    The amount of time, in seconds, during which no response means a failed health check.
    
    Returns:
    
    The amount of time, in seconds, during which no response means a failed health check.
  - withHealthCheckTimeoutSeconds
```
public TargetGroup withHealthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)
```
    The amount of time, in seconds, during which no response means a failed health check.
    
    Parameters:
    
    healthCheckTimeoutSeconds - The amount of time, in seconds, during which no response means a failed health check.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthyThresholdCount
```
public void setHealthyThresholdCount(Integer healthyThresholdCount)
```
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    
    Parameters:
    
    healthyThresholdCount - The number of consecutive health checks successes required before considering an unhealthy target healthy.
  - getHealthyThresholdCount
```
public Integer getHealthyThresholdCount()
```
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    
    Returns:
    
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
  - withHealthyThresholdCount
```
public TargetGroup withHealthyThresholdCount(Integer healthyThresholdCount)
```
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    
    Parameters:
    
    healthyThresholdCount - The number of consecutive health checks successes required before considering an unhealthy target healthy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnhealthyThresholdCount
```
public void setUnhealthyThresholdCount(Integer unhealthyThresholdCount)
```
    The number of consecutive health check failures required before considering the target unhealthy.
    
    Parameters:
    
    unhealthyThresholdCount - The number of consecutive health check failures required before considering the target unhealthy.
  - getUnhealthyThresholdCount
```
public Integer getUnhealthyThresholdCount()
```
    The number of consecutive health check failures required before considering the target unhealthy.
    
    Returns:
    
    The number of consecutive health check failures required before considering the target unhealthy.
  - withUnhealthyThresholdCount
```
public TargetGroup withUnhealthyThresholdCount(Integer unhealthyThresholdCount)
```
    The number of consecutive health check failures required before considering the target unhealthy.
    
    Parameters:
    
    unhealthyThresholdCount - The number of consecutive health check failures required before considering the target unhealthy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthCheckPath
```
public void setHealthCheckPath(String healthCheckPath)
```
    The destination for the health check request.
    
    Parameters:
    
    healthCheckPath - The destination for the health check request.
  - getHealthCheckPath
```
public String getHealthCheckPath()
```
    The destination for the health check request.
    
    Returns:
    
    The destination for the health check request.
  - withHealthCheckPath
```
public TargetGroup withHealthCheckPath(String healthCheckPath)
```
    The destination for the health check request.
    
    Parameters:
    
    healthCheckPath - The destination for the health check request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMatcher
```
public void setMatcher(Matcher matcher)
```
    The HTTP codes to use when checking for a successful response from a target.
    
    Parameters:
    
    matcher - The HTTP codes to use when checking for a successful response from a target.
  - getMatcher
```
public Matcher getMatcher()
```
    The HTTP codes to use when checking for a successful response from a target.
    
    Returns:
    
    The HTTP codes to use when checking for a successful response from a target.
  - withMatcher
```
public TargetGroup withMatcher(Matcher matcher)
```
    The HTTP codes to use when checking for a successful response from a target.
    
    Parameters:
    
    matcher - The HTTP codes to use when checking for a successful response from a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLoadBalancerArns
```
public List<String> getLoadBalancerArns()
```
    The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
    
    Returns:
    
    The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
  - setLoadBalancerArns
```
public void setLoadBalancerArns(Collection<String> loadBalancerArns)
```
    The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
    
    Parameters:
    
    loadBalancerArns - The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
  - withLoadBalancerArns
```
public TargetGroup withLoadBalancerArns(String... loadBalancerArns)
```
    The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
    
    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.
    
    Parameters:
    
    loadBalancerArns - The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLoadBalancerArns
```
public TargetGroup withLoadBalancerArns(Collection<String> loadBalancerArns)
```
    The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
    
    Parameters:
    
    loadBalancerArns - The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetType
```
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 (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    Parameters:
    
    targetType - The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    See Also:
    
    TargetTypeEnum
  - getTargetType
```
public String getTargetType()
```
    The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    Returns:
    
    The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    See Also:
    
    TargetTypeEnum
  - withTargetType
```
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 (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    Parameters:
    
    targetType - The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetTypeEnum
  - setTargetType
```
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 (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    Parameters:
    
    targetType - The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    See Also:
    
    TargetTypeEnum
  - withTargetType
```
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 (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    Parameters:
    
    targetType - The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetTypeEnum
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 TargetGroup clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class TargetGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TargetGroup

Method Detail

setTargetGroupArn

getTargetGroupArn

withTargetGroupArn

setTargetGroupName

getTargetGroupName

withTargetGroupName

setProtocol

getProtocol

withProtocol

setProtocol

withProtocol

setPort

getPort

withPort

setVpcId

getVpcId

withVpcId

setHealthCheckProtocol

getHealthCheckProtocol

withHealthCheckProtocol

setHealthCheckProtocol

withHealthCheckProtocol

setHealthCheckPort

getHealthCheckPort

withHealthCheckPort

setHealthCheckIntervalSeconds

getHealthCheckIntervalSeconds

withHealthCheckIntervalSeconds

setHealthCheckTimeoutSeconds

getHealthCheckTimeoutSeconds

withHealthCheckTimeoutSeconds

setHealthyThresholdCount

getHealthyThresholdCount

withHealthyThresholdCount

setUnhealthyThresholdCount

getUnhealthyThresholdCount

withUnhealthyThresholdCount

setHealthCheckPath

getHealthCheckPath

withHealthCheckPath

setMatcher

getMatcher

withMatcher

getLoadBalancerArns

setLoadBalancerArns

withLoadBalancerArns

withLoadBalancerArns

setTargetType

getTargetType

withTargetType

setTargetType

withTargetType

toString

equals

hashCode

clone