Class TrafficSourceIdentifier

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

Identifying information for a traffic source.

See Also:

  • Method Details

    • identifier

      public final String identifier()

      Identifies the traffic source.

      For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.

      For example:

      • Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456

      • Classic Load Balancer name: my-classic-load-balancer

      • VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456

      To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

      To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.

      Returns:
      Identifies the traffic source.

      For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.

      For example:

      • Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456

      • Classic Load Balancer name: my-classic-load-balancer

      • VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456

      To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

      To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.

    • type

      public final String type()

      Provides additional context for the value of Identifier.

      The following lists the valid values:

      • elb if Identifier is the name of a Classic Load Balancer.

      • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.

      • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.

      Required if the identifier is the name of a Classic Load Balancer.

      Returns:
      Provides additional context for the value of Identifier.

      The following lists the valid values:

      • elb if Identifier is the name of a Classic Load Balancer.

      • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.

      • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.

      Required if the identifier is the name of a Classic Load Balancer.

    • toBuilder

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

    • builder

      public static TrafficSourceIdentifier.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TrafficSourceIdentifier.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.