Package software.amazon.awscdk.cfnpropertymixins.services.ecs

Class CfnServicePropsMixin.LoadBalancerProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ecs.CfnServicePropsMixin.LoadBalancerProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServicePropsMixin.LoadBalancerProperty>

Enclosing interface:

CfnServicePropsMixin.LoadBalancerProperty

@Stability(Stable)
public static final class CfnServicePropsMixin.LoadBalancerProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnServicePropsMixin.LoadBalancerProperty>

A builder for CfnServicePropsMixin.LoadBalancerProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnServicePropsMixin.LoadBalancerProperty.Builder	advancedConfiguration(CfnServicePropsMixin.AdvancedConfigurationProperty advancedConfiguration)	Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getAdvancedConfiguration()
CfnServicePropsMixin.LoadBalancerProperty.Builder	advancedConfiguration(IResolvable advancedConfiguration)	Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getAdvancedConfiguration()
CfnServicePropsMixin.LoadBalancerProperty	build()	Builds the configured instance.
CfnServicePropsMixin.LoadBalancerProperty.Builder	containerName(String containerName)	Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getContainerName()
CfnServicePropsMixin.LoadBalancerProperty.Builder	containerPort(Number containerPort)	Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getContainerPort()
CfnServicePropsMixin.LoadBalancerProperty.Builder	loadBalancerName(String loadBalancerName)	Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getLoadBalancerName()
CfnServicePropsMixin.LoadBalancerProperty.Builder	targetGroupArn(String targetGroupArn)	Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getTargetGroupArn()
CfnServicePropsMixin.LoadBalancerProperty.Builder	targetGroupArn(ITargetGroupRef targetGroupArn)	Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getTargetGroupArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

advancedConfiguration

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty.Builder advancedConfiguration(IResolvable advancedConfiguration)

Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getAdvancedConfiguration()

Parameters:

advancedConfiguration - The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments.

Returns:

this

advancedConfiguration

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty.Builder advancedConfiguration(CfnServicePropsMixin.AdvancedConfigurationProperty advancedConfiguration)

Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getAdvancedConfiguration()

Parameters:

advancedConfiguration - The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments.

Returns:

this

containerName

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty.Builder containerName(String containerName)

Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getContainerName()

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:

this

containerPort

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty.Builder containerPort(Number containerPort)

Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getContainerPort()

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're launched on must allow ingress traffic on the hostPort of the port mapping.

Returns:

this

loadBalancerName

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty.Builder loadBalancerName(String loadBalancerName)

Sets the value of CfnServicePropsMixin.LoadBalancerProperty.getLoadBalancerName()

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:

this

targetGroupArn

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty.Builder targetGroupArn(String targetGroupArn)

Sets the value of CfnServicePropsMixin.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.

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 choose ip as the target type, not instance . Do this 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. This network mode is required for the Fargate launch type.

Returns:

this

targetGroupArn

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty.Builder targetGroupArn(ITargetGroupRef targetGroupArn)

Sets the value of CfnServicePropsMixin.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.

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 choose ip as the target type, not instance . Do this 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. This network mode is required for the Fargate launch type.

Returns:

this

build

@Stability(Stable)
public CfnServicePropsMixin.LoadBalancerProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnServicePropsMixin.LoadBalancerProperty>

Returns:

a new instance of CfnServicePropsMixin.LoadBalancerProperty

Throws:

NullPointerException - if any required attribute was not provided