Interface TrafficSourceIdentifier.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<TrafficSourceIdentifier.Builder,TrafficSourceIdentifier>
,SdkBuilder<TrafficSourceIdentifier.Builder,TrafficSourceIdentifier>
,SdkPojo
- Enclosing class:
- TrafficSourceIdentifier
public static interface TrafficSourceIdentifier.Builder extends SdkPojo, CopyableBuilder<TrafficSourceIdentifier.Builder,TrafficSourceIdentifier>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TrafficSourceIdentifier.Builder
identifier(String identifier)
Identifies the traffic source.TrafficSourceIdentifier.Builder
type(String type)
Provides additional context for the value ofIdentifier
.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
identifier
TrafficSourceIdentifier.Builder identifier(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
type
TrafficSourceIdentifier.Builder type(String type)
Provides additional context for the value of
Identifier
.The following lists the valid values:
-
elb
ifIdentifier
is the name of a Classic Load Balancer. -
elbv2
ifIdentifier
is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group. -
vpc-lattice
ifIdentifier
is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
- Parameters:
type
- Provides additional context for the value ofIdentifier
.The following lists the valid values:
-
elb
ifIdentifier
is the name of a Classic Load Balancer. -
elbv2
ifIdentifier
is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group. -
vpc-lattice
ifIdentifier
is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
-