Class CfnTaskSet.LoadBalancerProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTaskSet.LoadBalancerProperty>
- Enclosing interface:
CfnTaskSet.LoadBalancerProperty
CfnTaskSet.LoadBalancerProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.containerName
(String containerName) Sets the value ofCfnTaskSet.LoadBalancerProperty.getContainerName()
containerPort
(Number containerPort) Sets the value ofCfnTaskSet.LoadBalancerProperty.getContainerPort()
loadBalancerName
(String loadBalancerName) Sets the value ofCfnTaskSet.LoadBalancerProperty.getLoadBalancerName()
targetGroupArn
(String targetGroupArn) Sets the value ofCfnTaskSet.LoadBalancerProperty.getTargetGroupArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
containerName
@Stability(Stable) public CfnTaskSet.LoadBalancerProperty.Builder containerName(String containerName) Sets the value ofCfnTaskSet.LoadBalancerProperty.getContainerName()
- Parameters:
containerName
- The name of the container (as it appears in a container definition) to associate with the load balancer.- Returns:
this
-
containerPort
@Stability(Stable) public CfnTaskSet.LoadBalancerProperty.Builder containerPort(Number containerPort) Sets the value ofCfnTaskSet.LoadBalancerProperty.getContainerPort()
- 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:
this
-
loadBalancerName
@Stability(Stable) public CfnTaskSet.LoadBalancerProperty.Builder loadBalancerName(String loadBalancerName) Sets the value ofCfnTaskSet.LoadBalancerProperty.getLoadBalancerName()
- 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:
this
-
targetGroupArn
@Stability(Stable) public CfnTaskSet.LoadBalancerProperty.Builder targetGroupArn(String targetGroupArn) Sets the value ofCfnTaskSet.LoadBalancerProperty.getTargetGroupArn()
- 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're using a Classic Load Balancer, omit the target group ARN.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:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnTaskSet.LoadBalancerProperty>
- Returns:
- a new instance of
CfnTaskSet.LoadBalancerProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-