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 the load balancer to associate with the Amazon ECS service or task set.
LoadBalancer.Builder	targetGroupArn(String targetGroupArn) The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

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

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 or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

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, when creating your target groups 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 or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

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, when creating your target groups 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 the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Parameters:

loadBalancerName - The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on 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 task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on 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.