software.amazon.awssdk.services.elasticloadbalancingv2.model

Interface TargetDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TargetDescription.Builder,TargetDescription>, SdkBuilder<TargetDescription.Builder,TargetDescription>, SdkPojo

Enclosing class:

TargetDescription

public static interface TargetDescription.Builder
extends SdkPojo, CopyableBuilder<TargetDescription.Builder,TargetDescription>

Method Summary

Modifier and Type	Method and Description
TargetDescription.Builder	availabilityZone(String availabilityZone) An Availability Zone or all.
TargetDescription.Builder	id(String id) The ID of the target.
TargetDescription.Builder	port(Integer port) The port on which the target is listening.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

id

TargetDescription.Builder id(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

port

TargetDescription.Builder port(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. Not used if the target is a Lambda function.

Parameters:

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. Not used if the target is a Lambda function.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZone

TargetDescription.Builder availabilityZone(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.

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.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

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

Parameters:

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.

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.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

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

Returns:

Returns a reference to this object so that method calls can be chained together.