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

Class TargetDescription

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

Information about a target.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.

      Returns:
      The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.

    • port

      public final Integer port()

      The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.

      Returns:
      The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.

    • availabilityZone

      public final String availabilityZone()

      An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

      For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.

      This parameter is not supported if the target type of the target group is instance or alb.

      If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

      For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

      If the target type is lambda, this parameter is optional and the only supported value is all.

      Returns:
      An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

      For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all .

      This parameter is not supported if the target type of the target group is instance or alb.

      If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

      For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

      If the target type is lambda, this parameter is optional and the only supported value is all.

    • quicServerId

      public final String quicServerId()

      The server ID for the targets. This value is required if the protocol is QUIC or TCP_QUIC and can't be used with other protocols.

      The ID consists of the 0x prefix followed by 16 hexadecimal characters. Any letters must be lowercase. The value must be unique at the listener level. You can't modify the server ID for a registered target. You must deregister the target and then provide a new server ID when you register the target again.

      Returns:
      The server ID for the targets. This value is required if the protocol is QUIC or TCP_QUIC and can't be used with other protocols.

      The ID consists of the 0x prefix followed by 16 hexadecimal characters. Any letters must be lowercase. The value must be unique at the listener level. You can't modify the server ID for a registered target. You must deregister the target and then provide a new server ID when you register the target again.

    • toBuilder

      public TargetDescription.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<TargetDescription.Builder,TargetDescription>

    • builder

      public static TargetDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TargetDescription.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo