Class TargetGroup
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TargetGroup.Builder,
TargetGroup>
Information about a target group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TargetGroup.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LoadBalancerArns property.final Boolean
Indicates whether health checks are enabled.final Integer
The approximate amount of time, in seconds, between health checks of an individual target.final String
The destination for health checks on the targets.final String
The port to use to connect with the target.final ProtocolEnum
The protocol to use to connect with the target.final String
The protocol to use to connect with the target.final Integer
The amount of time, in seconds, during which no response means a failed health check.final Integer
The number of consecutive health checks successes required before considering an unhealthy target healthy.The type of IP address used for this target group.final String
The type of IP address used for this target group.The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.final Matcher
matcher()
The HTTP or gRPC codes to use when checking for a successful response from a target.final Integer
port()
The port on which the targets are listening.final ProtocolEnum
protocol()
The protocol to use for routing traffic to the targets.final String
The protocol to use for routing traffic to the targets.final String
[HTTP/HTTPS protocol] The protocol version.static Class
<? extends TargetGroup.Builder> final String
The Amazon Resource Name (ARN) of the target group.final String
The name of the target group.final TargetTypeEnum
The type of target that you must specify when registering targets with this target group.final String
The type of target that you must specify when registering targets with this target group.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The number of consecutive health check failures required before considering the target unhealthy.final String
vpcId()
The ID of the VPC for the targets.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
targetGroupArn
The Amazon Resource Name (ARN) of the target group.
- Returns:
- The Amazon Resource Name (ARN) of the target group.
-
targetGroupName
The name of the target group.
- Returns:
- The name of the target group.
-
protocol
The protocol to use for routing traffic to the targets.
If the service returns an enum value that is not available in the current SDK version,
protocol
will returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The protocol to use for routing traffic to the targets.
- See Also:
-
protocolAsString
The protocol to use for routing traffic to the targets.
If the service returns an enum value that is not available in the current SDK version,
protocol
will returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The protocol to use for routing traffic to the targets.
- See Also:
-
port
The port on which the targets are listening. This parameter is not used if the target is a Lambda function.
- Returns:
- The port on which the targets are listening. This parameter is not used if the target is a Lambda function.
-
vpcId
The ID of the VPC for the targets.
- Returns:
- The ID of the VPC for the targets.
-
healthCheckProtocol
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
If the service returns an enum value that is not available in the current SDK version,
healthCheckProtocol
will returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthCheckProtocolAsString()
.- Returns:
- The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
- See Also:
-
healthCheckProtocolAsString
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
If the service returns an enum value that is not available in the current SDK version,
healthCheckProtocol
will returnProtocolEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthCheckProtocolAsString()
.- Returns:
- The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
- See Also:
-
healthCheckPort
The port to use to connect with the target.
- Returns:
- The port to use to connect with the target.
-
healthCheckEnabled
Indicates whether health checks are enabled.
- Returns:
- Indicates whether health checks are enabled.
-
healthCheckIntervalSeconds
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.
-
healthCheckTimeoutSeconds
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.
-
healthyThresholdCount
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.
-
unhealthyThresholdCount
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.
-
healthCheckPath
The destination for health checks on the targets.
- Returns:
- The destination for health checks on the targets.
-
matcher
The HTTP or gRPC codes to use when checking for a successful response from a target.
- Returns:
- The HTTP or gRPC codes to use when checking for a successful response from a target.
-
hasLoadBalancerArns
public final boolean hasLoadBalancerArns()For responses, this returns true if the service returned a value for the LoadBalancerArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLoadBalancerArns()
method.- Returns:
- 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.
-
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), oralb
(register a single Application Load Balancer as a target).If the service returns an enum value that is not available in the current SDK version,
targetType
will returnTargetTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTypeAsString()
.- Returns:
- 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), oralb
(register a single Application Load Balancer as a target). - See Also:
-
targetTypeAsString
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), oralb
(register a single Application Load Balancer as a target).If the service returns an enum value that is not available in the current SDK version,
targetType
will returnTargetTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTypeAsString()
.- Returns:
- 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), oralb
(register a single Application Load Balancer as a target). - See Also:
-
protocolVersion
[HTTP/HTTPS protocol] The protocol version. The possible values are
GRPC
,HTTP1
, andHTTP2
.- Returns:
- [HTTP/HTTPS protocol] The protocol version. The possible values are
GRPC
,HTTP1
, andHTTP2
.
-
ipAddressType
The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnTargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
. - See Also:
-
ipAddressTypeAsString
The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnTargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TargetGroup.Builder,
TargetGroup> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-