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
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.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
-
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.
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're 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, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.- 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.
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're 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, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.- 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.
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.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.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
- Parameters:
containerName
- The name of the container (as it appears in a container definition) to associate with the load balancer.You need to specify the container name when configuring the target group for an Amazon ECS 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're launched on must allow ingress traffic on thehostPort
of the port mapping.- Parameters:
containerPort
- The port on the container to associate with the load balancer. This port must correspond to acontainerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on thehostPort
of the port mapping.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-