Package software.amazon.awssdk.services.elasticloadbalancingv2.model

Class TargetGroup

java.lang.Object
software.amazon.awssdk.services.elasticloadbalancingv2.model.TargetGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TargetGroup.Builder,TargetGroup>
@Generated("software.amazon.awssdk:codegen") public final class TargetGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TargetGroup.Builder,TargetGroup>

Information about a target group.

See Also:

  • Method Details

    • targetGroupArn

      public final String targetGroupArn()

      The Amazon Resource Name (ARN) of the target group.

      Returns:
      The Amazon Resource Name (ARN) of the target group.

    • targetGroupName

      public final String targetGroupName()

      The name of the target group.

      Returns:
      The name of the target group.

    • protocol

      public final ProtocolEnum 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 return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The protocol to use for routing traffic to the targets.
      See Also:

    • protocolAsString

      public final String 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 return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The protocol to use for routing traffic to the targets.
      See Also:

    • port

      public final Integer 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

      public final String vpcId()

      The ID of the VPC for the targets.

      Returns:
      The ID of the VPC for the targets.

    • healthCheckProtocol

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

      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

      public final String 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 return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().

      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

      public final String healthCheckPort()

      The port to use to connect with the target.

      Returns:
      The port to use to connect with the target.

    • healthCheckEnabled

      public final Boolean healthCheckEnabled()

      Indicates whether health checks are enabled.

      Returns:
      Indicates whether health checks are enabled.

    • healthCheckIntervalSeconds

      public final Integer 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

      public final Integer 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

      public final Integer 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

      public final Integer 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

      public final String healthCheckPath()

      The destination for health checks on the targets.

      Returns:
      The destination for health checks on the targets.

    • matcher

      public final Matcher 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 the isEmpty() 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

      public final List<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.

      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

      public final 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).

      If the service returns an enum value that is not available in the current SDK version, targetType will return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

      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), or alb (register a single Application Load Balancer as a target).
      See Also:

    • targetTypeAsString

      public final String 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), or alb (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 return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

      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), or alb (register a single Application Load Balancer as a target).
      See Also:

    • protocolVersion

      public final String protocolVersion()

      [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

      Returns:
      [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1 , and HTTP2.

    • ipAddressType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return TargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      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.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return TargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      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.
      See Also:

    • toBuilder

      public TargetGroup.Builder 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 interface ToCopyableBuilder<TargetGroup.Builder,TargetGroup>
      Returns:
      a builder for type T

    • builder

      public static TargetGroup.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TargetGroup.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.