software.amazon.awscdk.services.ecs

Interface CfnService.LoadBalancerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.LoadBalancerProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(value=Stable)
public static interface CfnService.LoadBalancerProperty
extends software.amazon.jsii.JsiiSerializable

The `LoadBalancer` property specifies details on a load balancer that is used with a service.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair ). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance . Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 LoadBalancerProperty loadBalancerProperty = LoadBalancerProperty.builder()
         .containerPort(123)
         // the properties below are optional
         .containerName("containerName")
         .loadBalancerName("loadBalancerName")
         .targetGroupArn("targetGroupArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnService.LoadBalancerProperty.Builder A builder for CfnService.LoadBalancerProperty
static class	CfnService.LoadBalancerProperty.Jsii$Proxy An implementation for CfnService.LoadBalancerProperty

Method Summary

Modifier and Type	Method and Description
static CfnService.LoadBalancerProperty.Builder	builder()
default String	getContainerName() The name of the container (as it appears in a container definition) to associate with the load balancer.
Number	getContainerPort() The port on the container to associate with the load balancer.
default String	getLoadBalancerName() The name of the load balancer to associate with the Amazon ECS service or task set.
default String	getTargetGroupArn() 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.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContainerPort

@Stability(value=Stable)
 @NotNull
Number getContainerPort()

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.

getContainerName

@Stability(value=Stable)
 @Nullable
default String getContainerName()

The name of the container (as it appears in a container definition) to associate with the load balancer.

getLoadBalancerName

@Stability(value=Stable)
 @Nullable
default String getLoadBalancerName()

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.

getTargetGroupArn

@Stability(value=Stable)
 @Nullable
default String getTargetGroupArn()

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 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.

builder

@Stability(value=Stable)
static CfnService.LoadBalancerProperty.Builder builder()

Returns:

a CfnService.LoadBalancerProperty.Builder of CfnService.LoadBalancerProperty