1.204.0

interface LoadBalancerProperty

LanguageType name
.NETAmazon.CDK.AWS.ECS.CfnTaskSet.LoadBalancerProperty
Javasoftware.amazon.awscdk.services.ecs.CfnTaskSet.LoadBalancerProperty
Pythonaws_cdk.aws_ecs.CfnTaskSet.LoadBalancerProperty
TypeScript @aws-cdk/aws-ecs » CfnTaskSet » LoadBalancerProperty

The load balancer configuration to use with a service or task set.

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.

We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.

A service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles in the Amazon Elastic Container Service Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const loadBalancerProperty: ecs.CfnTaskSet.LoadBalancerProperty = {
  containerName: 'containerName',
  containerPort: 123,
  loadBalancerName: 'loadBalancerName',
  targetGroupArn: 'targetGroupArn',
};

Properties

NameTypeDescription
containerName?stringThe name of the container (as it appears in a container definition) to associate with the load balancer.
containerPort?numberThe port on the container to associate with the load balancer.
loadBalancerName?stringThe name of the load balancer to associate with the Amazon ECS service or task set.
targetGroupArn?stringThe full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

containerName?

Type: string (optional)

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

containerPort?

Type: number (optional)

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.

loadBalancerName?

Type: string (optional)

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.

targetGroupArn?

Type: string (optional)

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.

← PreviousNext →