Package software.amazon.awscdk.services.ecs

Class CfnTaskSet.LoadBalancerProperty.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.CfnTaskSet.LoadBalancerProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTaskSet.LoadBalancerProperty>
Enclosing interface:
CfnTaskSet.LoadBalancerProperty
@Stability(Stable) public static final class CfnTaskSet.LoadBalancerProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnTaskSet.LoadBalancerProperty>
A builder for CfnTaskSet.LoadBalancerProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • containerName

      @Stability(Stable) public CfnTaskSet.LoadBalancerProperty.Builder containerName(String containerName)
      Sets the value of CfnTaskSet.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 CfnTaskSet.LoadBalancerProperty.Builder containerPort(Number containerPort)
      Sets the value of CfnTaskSet.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

    • targetGroupArn

      @Stability(Stable) public CfnTaskSet.LoadBalancerProperty.Builder targetGroupArn(String targetGroupArn)
      Sets the value of CfnTaskSet.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 CfnTaskSet.LoadBalancerProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTaskSet.LoadBalancerProperty>
      Returns:
      a new instance of CfnTaskSet.LoadBalancerProperty
      Throws:
      NullPointerException - if any required attribute was not provided