software.amazon.awssdk.services.ecs.model

Interface LoadBalancer.Builder

All Superinterfaces:

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

Enclosing class:

LoadBalancer

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

Method Summary

Modifier and Type	Method and Description
LoadBalancer.Builder	containerName(String containerName) The name of the container (as it appears in a container definition) to associate with the load balancer.
LoadBalancer.Builder	containerPort(Integer containerPort) The port on the container to associate with the load balancer.
LoadBalancer.Builder	loadBalancerName(String loadBalancerName) The name of a load balancer.
LoadBalancer.Builder	targetGroupArn(String targetGroupArn) The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service.

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

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

targetGroupArn

LoadBalancer.Builder targetGroupArn(String targetGroupArn)

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Parameters:

targetGroupArn - The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Returns:

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

loadBalancerName

LoadBalancer.Builder loadBalancerName(String loadBalancerName)

The name of a load balancer.

Parameters:

loadBalancerName - The name of a load balancer.

Returns:

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

containerName

LoadBalancer.Builder containerName(String containerName)

The name of the container (as it appears in a container definition) to associate with the load balancer.

Parameters:

containerName - The name of the container (as it appears in a container definition) to associate with the load balancer.

Returns:

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

containerPort

LoadBalancer.Builder containerPort(Integer containerPort)

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

Parameters:

containerPort - The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

Returns:

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