Package software.amazon.awscdk.services.ecs.patterns

@Stability(Stable) @Deprecated package software.amazon.awscdk.services.ecs.patterns

Deprecated.

CDK Construct library for higher-level ECS Constructs

---

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.

This library provides higher-level Amazon ECS constructs which follow common architectural patterns. It contains:

• Application Load Balanced Services
• Network Load Balanced Services
• Queue Processing Services
• Scheduled Tasks (cron jobs)
• Additional Examples

Application Load Balanced Services

To define an Amazon ECS service that is behind an application load balancer, instantiate one of the following:

• ApplicationLoadBalancedEc2Service

 Cluster cluster;
 
 ApplicationLoadBalancedEc2Service loadBalancedEcsService = ApplicationLoadBalancedEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("test"))
                 .environment(Map.of(
                         "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
                         "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
                 .build())
         .desiredCount(2)
         .build();
 

• ApplicationLoadBalancedFargateService

 Cluster cluster;
 
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .build();
 
 loadBalancedFargateService.targetGroup.configureHealthCheck(HealthCheck.builder()
         .path("/custom-health-path")
         .build());
 

Instead of providing a cluster you can specify a VPC and CDK will create a new ECS cluster. If you deploy multiple services CDK will only create one cluster per VPC.

You can omit cluster and vpc to let CDK create a new VPC with two AZs and create a cluster inside this VPC.

You can customize the health check for your target group; otherwise it defaults to HTTP over port 80 hitting path /.

Fargate services will use the LATEST platform version by default, but you can override by providing a value for the platformVersion property in the constructor.

Fargate services use the default VPC Security Group unless one or more are provided using the securityGroups property in the constructor.

By setting redirectHTTP to true, CDK will automatically create a listener on port 80 that redirects HTTP traffic to the HTTPS port.

If you specify the option recordType you can decide if you want the construct to use CNAME or Route53-Aliases as record sets.

If you need to encrypt the traffic between the load balancer and the ECS tasks, you can set the targetProtocol to HTTPS.

Additionally, if more than one application target group are needed, instantiate one of the following:

• ApplicationMultipleTargetGroupsEc2Service

 // One application load balancer with one listener and two target groups.
 Cluster cluster;
 
 ApplicationMultipleTargetGroupsEc2Service loadBalancedEc2Service = ApplicationMultipleTargetGroupsEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(256)
         .taskImageOptions(ApplicationLoadBalancedTaskImageProps.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .targetGroups(List.of(ApplicationTargetProps.builder()
                 .containerPort(80)
                 .build(), ApplicationTargetProps.builder()
                 .containerPort(90)
                 .pathPattern("a/b/c")
                 .priority(10)
                 .build()))
         .build();
 

• ApplicationMultipleTargetGroupsFargateService

 // One application load balancer with one listener and two target groups.
 Cluster cluster;
 
 ApplicationMultipleTargetGroupsFargateService loadBalancedFargateService = ApplicationMultipleTargetGroupsFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageProps.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .targetGroups(List.of(ApplicationTargetProps.builder()
                 .containerPort(80)
                 .build(), ApplicationTargetProps.builder()
                 .containerPort(90)
                 .pathPattern("a/b/c")
                 .priority(10)
                 .build()))
         .build();
 

Network Load Balanced Services

To define an Amazon ECS service that is behind a network load balancer, instantiate one of the following:

• NetworkLoadBalancedEc2Service

 Cluster cluster;
 
 NetworkLoadBalancedEc2Service loadBalancedEcsService = NetworkLoadBalancedEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .taskImageOptions(NetworkLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("test"))
                 .environment(Map.of(
                         "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
                         "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
                 .build())
         .desiredCount(2)
         .build();
 

• NetworkLoadBalancedFargateService

 Cluster cluster;
 
 NetworkLoadBalancedFargateService loadBalancedFargateService = NetworkLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .cpu(512)
         .taskImageOptions(NetworkLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .build();
 

The CDK will create a new Amazon ECS cluster if you specify a VPC and omit cluster. If you deploy multiple services the CDK will only create one cluster per VPC.

If cluster and vpc are omitted, the CDK creates a new VPC with subnets in two Availability Zones and a cluster within this VPC.

If you specify the option recordType you can decide if you want the construct to use CNAME or Route53-Aliases as record sets.

Additionally, if more than one network target group is needed, instantiate one of the following:

• NetworkMultipleTargetGroupsEc2Service

 // Two network load balancers, each with their own listener and target group.
 Cluster cluster;
 
 NetworkMultipleTargetGroupsEc2Service loadBalancedEc2Service = NetworkMultipleTargetGroupsEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(256)
         .taskImageOptions(NetworkLoadBalancedTaskImageProps.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .loadBalancers(List.of(NetworkLoadBalancerProps.builder()
                 .name("lb1")
                 .listeners(List.of(NetworkListenerProps.builder()
                         .name("listener1")
                         .build()))
                 .build(), NetworkLoadBalancerProps.builder()
                 .name("lb2")
                 .listeners(List.of(NetworkListenerProps.builder()
                         .name("listener2")
                         .build()))
                 .build()))
         .targetGroups(List.of(NetworkTargetProps.builder()
                 .containerPort(80)
                 .listener("listener1")
                 .build(), NetworkTargetProps.builder()
                 .containerPort(90)
                 .listener("listener2")
                 .build()))
         .build();
 

• NetworkMultipleTargetGroupsFargateService

 // Two network load balancers, each with their own listener and target group.
 Cluster cluster;
 
 NetworkMultipleTargetGroupsFargateService loadBalancedFargateService = NetworkMultipleTargetGroupsFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(512)
         .taskImageOptions(NetworkLoadBalancedTaskImageProps.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .loadBalancers(List.of(NetworkLoadBalancerProps.builder()
                 .name("lb1")
                 .listeners(List.of(NetworkListenerProps.builder()
                         .name("listener1")
                         .build()))
                 .build(), NetworkLoadBalancerProps.builder()
                 .name("lb2")
                 .listeners(List.of(NetworkListenerProps.builder()
                         .name("listener2")
                         .build()))
                 .build()))
         .targetGroups(List.of(NetworkTargetProps.builder()
                 .containerPort(80)
                 .listener("listener1")
                 .build(), NetworkTargetProps.builder()
                 .containerPort(90)
                 .listener("listener2")
                 .build()))
         .build();
 

Queue Processing Services

To define a service that creates a queue and reads from that queue, instantiate one of the following:

• QueueProcessingEc2Service

 Cluster cluster;
 
 QueueProcessingEc2Service queueProcessingEc2Service = QueueProcessingEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .image(ContainerImage.fromRegistry("test"))
         .command(List.of("-c", "4", "amazon.com"))
         .enableLogging(false)
         .desiredTaskCount(2)
         .environment(Map.of(
                 "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
                 "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
         .maxScalingCapacity(5)
         .containerName("test")
         .build();
 

• QueueProcessingFargateService

 Cluster cluster;
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .command(List.of("-c", "4", "amazon.com"))
         .enableLogging(false)
         .desiredTaskCount(2)
         .environment(Map.of(
                 "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
                 "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
         .maxScalingCapacity(5)
         .containerName("test")
         .build();
 

when queue not provided by user, CDK will create a primary queue and a dead letter queue with default redrive policy and attach permission to the task to be able to access the primary queue.

Scheduled Tasks

To define a task that runs periodically, there are 2 options:

• ScheduledEc2Task

 // Instantiate an Amazon EC2 Task to run at a scheduled interval
 Cluster cluster;
 
 ScheduledEc2Task ecsScheduledTask = ScheduledEc2Task.Builder.create(this, "ScheduledTask")
         .cluster(cluster)
         .scheduledEc2TaskImageOptions(ScheduledEc2TaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(256)
                 .environment(Map.of("name", "TRIGGER", "value", "CloudWatch Events"))
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .enabled(true)
         .ruleName("sample-scheduled-task-rule")
         .build();
 

• ScheduledFargateTask

 Cluster cluster;
 
 ScheduledFargateTask scheduledFargateTask = ScheduledFargateTask.Builder.create(this, "ScheduledFargateTask")
         .cluster(cluster)
         .scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(512)
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .platformVersion(FargatePlatformVersion.LATEST)
         .build();
 

Additional Examples

In addition to using the constructs, users can also add logic to customize these constructs:

Configure HTTPS on an ApplicationLoadBalancedFargateService

 import software.amazon.awscdk.services.route53.HostedZone;
 import software.amazon.awscdk.services.certificatemanager.Certificate;
 import software.amazon.awscdk.services.elasticloadbalancingv2.SslPolicy;
 
 Vpc vpc;
 Cluster cluster;
 
 
 IHostedZone domainZone = HostedZone.fromLookup(this, "Zone", HostedZoneProviderProps.builder().domainName("example.com").build());
 ICertificate certificate = Certificate.fromCertificateArn(this, "Cert", "arn:aws:acm:us-east-1:123456:certificate/abcdefg");
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .vpc(vpc)
         .cluster(cluster)
         .certificate(certificate)
         .sslPolicy(SslPolicy.RECOMMENDED)
         .domainName("api.example.com")
         .domainZone(domainZone)
         .redirectHTTP(true)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .build();
 

Add Schedule-Based Auto-Scaling to an ApplicationLoadBalancedFargateService

 Cluster cluster;
 
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .build();
 
 ScalableTaskCount scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount(EnableScalingProps.builder()
         .minCapacity(5)
         .maxCapacity(20)
         .build());
 
 scalableTarget.scaleOnSchedule("DaytimeScaleDown", ScalingSchedule.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("8").minute("0").build()))
         .minCapacity(1)
         .build());
 
 scalableTarget.scaleOnSchedule("EveningRushScaleUp", ScalingSchedule.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("20").minute("0").build()))
         .minCapacity(10)
         .build());
 

Add Metric-Based Auto-Scaling to an ApplicationLoadBalancedFargateService

 Cluster cluster;
 
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .build();
 
 ScalableTaskCount scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount(EnableScalingProps.builder()
         .minCapacity(1)
         .maxCapacity(20)
         .build());
 
 scalableTarget.scaleOnCpuUtilization("CpuScaling", CpuUtilizationScalingProps.builder()
         .targetUtilizationPercent(50)
         .build());
 
 scalableTarget.scaleOnMemoryUtilization("MemoryScaling", MemoryUtilizationScalingProps.builder()
         .targetUtilizationPercent(50)
         .build());
 

Change the default Deployment Controller

 Cluster cluster;
 
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.CODE_DEPLOY)
                 .build())
         .build();
 

Deployment circuit breaker and rollback

Amazon ECS deployment circuit breaker automatically rolls back unhealthy service deployments without the need for manual intervention. Use circuitBreaker to enable deployment circuit breaker and optionally enable rollback for automatic rollback. See Using the deployment circuit breaker for more details.

 Cluster cluster;
 
 ApplicationLoadBalancedFargateService service = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .circuitBreaker(DeploymentCircuitBreaker.builder().rollback(true).build())
         .build();
 

Set deployment configuration on QueueProcessingService

 Cluster cluster;
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .command(List.of("-c", "4", "amazon.com"))
         .enableLogging(false)
         .desiredTaskCount(2)
         .environment(Map.of())
         .maxScalingCapacity(5)
         .maxHealthyPercent(200)
         .minHealthyPercent(66)
         .build();
 

Set taskSubnets and securityGroups for QueueProcessingFargateService

 Vpc vpc;
 SecurityGroup securityGroup;
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .vpc(vpc)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .securityGroups(List.of(securityGroup))
         .taskSubnets(SubnetSelection.builder().subnetType(SubnetType.PRIVATE_ISOLATED).build())
         .build();
 

Define tasks with public IPs for QueueProcessingFargateService

 Vpc vpc;
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .vpc(vpc)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .assignPublicIp(true)
         .build();
 

Define tasks with custom queue parameters for QueueProcessingFargateService

 Vpc vpc;
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .vpc(vpc)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .maxReceiveCount(42)
         .retentionPeriod(Duration.days(7))
         .visibilityTimeout(Duration.minutes(5))
         .build();
 

Set capacityProviderStrategies for QueueProcessingFargateService

 Cluster cluster;
 
 cluster.enableFargateCapacityProviders();
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE_SPOT")
                 .weight(2)
                 .build(), CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE")
                 .weight(1)
                 .build()))
         .build();
 

Set a custom container-level Healthcheck for QueueProcessingFargateService

 Vpc vpc;
 SecurityGroup securityGroup;
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .vpc(vpc)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .healthCheck(HealthCheck.builder()
                 .command(List.of("CMD-SHELL", "curl -f http://localhost/ || exit 1"))
                 // the properties below are optional
                 .interval(Duration.minutes(30))
                 .retries(123)
                 .startPeriod(Duration.minutes(30))
                 .timeout(Duration.minutes(30))
                 .build())
         .build();
 

Set capacityProviderStrategies for QueueProcessingEc2Service

 import software.amazon.awscdk.services.autoscaling.*;
 
 
 Vpc vpc = Vpc.Builder.create(this, "Vpc").maxAzs(1).build();
 Cluster cluster = Cluster.Builder.create(this, "EcsCluster").vpc(vpc).build();
 AutoScalingGroup autoScalingGroup = AutoScalingGroup.Builder.create(this, "asg")
         .vpc(vpc)
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.MICRO))
         .machineImage(EcsOptimizedImage.amazonLinux2())
         .build();
 AsgCapacityProvider capacityProvider = AsgCapacityProvider.Builder.create(this, "provider")
         .autoScalingGroup(autoScalingGroup)
         .build();
 cluster.addAsgCapacityProvider(capacityProvider);
 
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider(capacityProvider.getCapacityProviderName())
                 .build()))
         .build();
 

Select specific vpc subnets for ApplicationLoadBalancedFargateService

 Cluster cluster;
 
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .taskSubnets(SubnetSelection.builder()
                 .subnets(List.of(Subnet.fromSubnetId(this, "subnet", "VpcISOLATEDSubnet1Subnet80F07FA0")))
                 .build())
         .build();
 

Set PlatformVersion for ScheduledFargateTask

 Cluster cluster;
 
 ScheduledFargateTask scheduledFargateTask = ScheduledFargateTask.Builder.create(this, "ScheduledFargateTask")
         .cluster(cluster)
         .scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(512)
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .platformVersion(FargatePlatformVersion.VERSION1_4)
         .build();
 

Set SecurityGroups for ScheduledFargateTask

 Vpc vpc = Vpc.Builder.create(this, "Vpc").maxAzs(1).build();
 Cluster cluster = Cluster.Builder.create(this, "EcsCluster").vpc(vpc).build();
 SecurityGroup securityGroup = SecurityGroup.Builder.create(this, "SG").vpc(vpc).build();
 
 ScheduledFargateTask scheduledFargateTask = ScheduledFargateTask.Builder.create(this, "ScheduledFargateTask")
         .cluster(cluster)
         .scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(512)
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .securityGroups(List.of(securityGroup))
         .build();
 

Use the REMOVE_DEFAULT_DESIRED_COUNT feature flag

The REMOVE_DEFAULT_DESIRED_COUNT feature flag is used to override the default desiredCount that is autogenerated by the CDK. This will set the desiredCount of any service created by any of the following constructs to be undefined.

• ApplicationLoadBalancedEc2Service
• ApplicationLoadBalancedFargateService
• NetworkLoadBalancedEc2Service
• NetworkLoadBalancedFargateService
• QueueProcessingEc2Service
• QueueProcessingFargateService

If a desiredCount is not passed in as input to the above constructs, CloudFormation will either create a new service to start up with a desiredCount of 1, or update an existing service to start up with the same desiredCount as prior to the update.

To enable the feature flag, ensure that the REMOVE_DEFAULT_DESIRED_COUNT flag within an application stack context is set to true, like so:

 Stack stack;
 
 stack.node.setContext(ECS_REMOVE_DEFAULT_DESIRED_COUNT, true);
 

The following is an example of an application with the REMOVE_DEFAULT_DESIRED_COUNT feature flag enabled:

 import software.amazon.awscdk.core.App;
 import software.amazon.awscdk.core.Stack;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 import software.amazon.awscdk.cxapi.*;
 import path.*;
 
 App app = new App();
 
 Stack stack = new Stack(app, "aws-ecs-patterns-queue");
 stack.node.setContext(ECS_REMOVE_DEFAULT_DESIRED_COUNT, true);
 
 Vpc vpc = Vpc.Builder.create(stack, "VPC")
         .maxAzs(2)
         .build();
 
 QueueProcessingFargateService.Builder.create(stack, "QueueProcessingService")
         .vpc(vpc)
         .memoryLimitMiB(512)
         .image(new AssetImage(join(__dirname, "..", "sqs-reader")))
         .build();
 

Deploy application and metrics sidecar

The following is an example of deploying an application along with a metrics sidecar container that utilizes dockerLabels for discovery:

 Cluster cluster;
 Vpc vpc;
 
 ApplicationLoadBalancedFargateService service = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .vpc(vpc)
         .desiredCount(1)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .dockerLabels(Map.of(
                         "application.label.one", "first_label",
                         "application.label.two", "second_label"))
                 .build())
         .build();
 
 service.taskDefinition.addContainer("Sidecar", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("example/metrics-sidecar"))
         .build());
 

Select specific load balancer name ApplicationLoadBalancedFargateService

 Cluster cluster;
 
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .taskSubnets(SubnetSelection.builder()
                 .subnets(List.of(Subnet.fromSubnetId(this, "subnet", "VpcISOLATEDSubnet1Subnet80F07FA0")))
                 .build())
         .loadBalancerName("application-lb-name")
         .build();
 

Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html

Related Packages

Package	Description
software.amazon.awscdk.services.ecs	Deprecated.

Class	Description
$Module
ApplicationListenerProps	Properties to define an application listener.
ApplicationListenerProps.Builder	A builder for ApplicationListenerProps
ApplicationListenerProps.Jsii$Proxy	An implementation for ApplicationListenerProps
ApplicationLoadBalancedEc2Service	An EC2 service running on an ECS cluster fronted by an application load balancer.
ApplicationLoadBalancedEc2Service.Builder	A fluent builder for ApplicationLoadBalancedEc2Service.
ApplicationLoadBalancedEc2ServiceProps	The properties for the ApplicationLoadBalancedEc2Service service.
ApplicationLoadBalancedEc2ServiceProps.Builder	A builder for ApplicationLoadBalancedEc2ServiceProps
ApplicationLoadBalancedEc2ServiceProps.Jsii$Proxy	An implementation for ApplicationLoadBalancedEc2ServiceProps
ApplicationLoadBalancedFargateService	A Fargate service running on an ECS cluster fronted by an application load balancer.
ApplicationLoadBalancedFargateService.Builder	A fluent builder for ApplicationLoadBalancedFargateService.
ApplicationLoadBalancedFargateServiceProps	The properties for the ApplicationLoadBalancedFargateService service.
ApplicationLoadBalancedFargateServiceProps.Builder	A builder for ApplicationLoadBalancedFargateServiceProps
ApplicationLoadBalancedFargateServiceProps.Jsii$Proxy	An implementation for ApplicationLoadBalancedFargateServiceProps
ApplicationLoadBalancedServiceBase	The base class for ApplicationLoadBalancedEc2Service and ApplicationLoadBalancedFargateService services.
ApplicationLoadBalancedServiceBaseProps	The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service.
ApplicationLoadBalancedServiceBaseProps.Builder	A builder for ApplicationLoadBalancedServiceBaseProps
ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy	An implementation for ApplicationLoadBalancedServiceBaseProps
ApplicationLoadBalancedServiceRecordType	Describes the type of DNS record the service should create.
ApplicationLoadBalancedTaskImageOptions	Example:
ApplicationLoadBalancedTaskImageOptions.Builder	A builder for ApplicationLoadBalancedTaskImageOptions
ApplicationLoadBalancedTaskImageOptions.Jsii$Proxy	An implementation for ApplicationLoadBalancedTaskImageOptions
ApplicationLoadBalancedTaskImageProps	Options for configuring a new container.
ApplicationLoadBalancedTaskImageProps.Builder	A builder for ApplicationLoadBalancedTaskImageProps
ApplicationLoadBalancedTaskImageProps.Jsii$Proxy	An implementation for ApplicationLoadBalancedTaskImageProps
ApplicationLoadBalancerProps	Properties to define an application load balancer.
ApplicationLoadBalancerProps.Builder	A builder for ApplicationLoadBalancerProps
ApplicationLoadBalancerProps.Jsii$Proxy	An implementation for ApplicationLoadBalancerProps
ApplicationMultipleTargetGroupsEc2Service	An EC2 service running on an ECS cluster fronted by an application load balancer.
ApplicationMultipleTargetGroupsEc2Service.Builder	A fluent builder for ApplicationMultipleTargetGroupsEc2Service.
ApplicationMultipleTargetGroupsEc2ServiceProps	The properties for the ApplicationMultipleTargetGroupsEc2Service service.
ApplicationMultipleTargetGroupsEc2ServiceProps.Builder	A builder for ApplicationMultipleTargetGroupsEc2ServiceProps
ApplicationMultipleTargetGroupsEc2ServiceProps.Jsii$Proxy	An implementation for ApplicationMultipleTargetGroupsEc2ServiceProps
ApplicationMultipleTargetGroupsFargateService	A Fargate service running on an ECS cluster fronted by an application load balancer.
ApplicationMultipleTargetGroupsFargateService.Builder	A fluent builder for ApplicationMultipleTargetGroupsFargateService.
ApplicationMultipleTargetGroupsFargateServiceProps	The properties for the ApplicationMultipleTargetGroupsFargateService service.
ApplicationMultipleTargetGroupsFargateServiceProps.Builder	A builder for ApplicationMultipleTargetGroupsFargateServiceProps
ApplicationMultipleTargetGroupsFargateServiceProps.Jsii$Proxy	An implementation for ApplicationMultipleTargetGroupsFargateServiceProps
ApplicationMultipleTargetGroupsServiceBase	The base class for ApplicationMultipleTargetGroupsEc2Service and ApplicationMultipleTargetGroupsFargateService classes.
ApplicationMultipleTargetGroupsServiceBaseProps	The properties for the base ApplicationMultipleTargetGroupsEc2Service or ApplicationMultipleTargetGroupsFargateService service.
ApplicationMultipleTargetGroupsServiceBaseProps.Builder	A builder for ApplicationMultipleTargetGroupsServiceBaseProps
ApplicationMultipleTargetGroupsServiceBaseProps.Jsii$Proxy	An implementation for ApplicationMultipleTargetGroupsServiceBaseProps
ApplicationTargetProps	Properties to define an application target group.
ApplicationTargetProps.Builder	A builder for ApplicationTargetProps
ApplicationTargetProps.Jsii$Proxy	An implementation for ApplicationTargetProps
NetworkListenerProps	Properties to define an network listener.
NetworkListenerProps.Builder	A builder for NetworkListenerProps
NetworkListenerProps.Jsii$Proxy	An implementation for NetworkListenerProps
NetworkLoadBalancedEc2Service	An EC2 service running on an ECS cluster fronted by a network load balancer.
NetworkLoadBalancedEc2Service.Builder	A fluent builder for NetworkLoadBalancedEc2Service.
NetworkLoadBalancedEc2ServiceProps	The properties for the NetworkLoadBalancedEc2Service service.
NetworkLoadBalancedEc2ServiceProps.Builder	A builder for NetworkLoadBalancedEc2ServiceProps
NetworkLoadBalancedEc2ServiceProps.Jsii$Proxy	An implementation for NetworkLoadBalancedEc2ServiceProps
NetworkLoadBalancedFargateService	A Fargate service running on an ECS cluster fronted by a network load balancer.
NetworkLoadBalancedFargateService.Builder	A fluent builder for NetworkLoadBalancedFargateService.
NetworkLoadBalancedFargateServiceProps	The properties for the NetworkLoadBalancedFargateService service.
NetworkLoadBalancedFargateServiceProps.Builder	A builder for NetworkLoadBalancedFargateServiceProps
NetworkLoadBalancedFargateServiceProps.Jsii$Proxy	An implementation for NetworkLoadBalancedFargateServiceProps
NetworkLoadBalancedServiceBase	The base class for NetworkLoadBalancedEc2Service and NetworkLoadBalancedFargateService services.
NetworkLoadBalancedServiceBaseProps	The properties for the base NetworkLoadBalancedEc2Service or NetworkLoadBalancedFargateService service.
NetworkLoadBalancedServiceBaseProps.Builder	A builder for NetworkLoadBalancedServiceBaseProps
NetworkLoadBalancedServiceBaseProps.Jsii$Proxy	An implementation for NetworkLoadBalancedServiceBaseProps
NetworkLoadBalancedServiceRecordType	Describes the type of DNS record the service should create.
NetworkLoadBalancedTaskImageOptions	Example:
NetworkLoadBalancedTaskImageOptions.Builder	A builder for NetworkLoadBalancedTaskImageOptions
NetworkLoadBalancedTaskImageOptions.Jsii$Proxy	An implementation for NetworkLoadBalancedTaskImageOptions
NetworkLoadBalancedTaskImageProps	Options for configuring a new container.
NetworkLoadBalancedTaskImageProps.Builder	A builder for NetworkLoadBalancedTaskImageProps
NetworkLoadBalancedTaskImageProps.Jsii$Proxy	An implementation for NetworkLoadBalancedTaskImageProps
NetworkLoadBalancerProps	Properties to define an network load balancer.
NetworkLoadBalancerProps.Builder	A builder for NetworkLoadBalancerProps
NetworkLoadBalancerProps.Jsii$Proxy	An implementation for NetworkLoadBalancerProps
NetworkMultipleTargetGroupsEc2Service	An EC2 service running on an ECS cluster fronted by a network load balancer.
NetworkMultipleTargetGroupsEc2Service.Builder	A fluent builder for NetworkMultipleTargetGroupsEc2Service.
NetworkMultipleTargetGroupsEc2ServiceProps	The properties for the NetworkMultipleTargetGroupsEc2Service service.
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	A builder for NetworkMultipleTargetGroupsEc2ServiceProps
NetworkMultipleTargetGroupsEc2ServiceProps.Jsii$Proxy	An implementation for NetworkMultipleTargetGroupsEc2ServiceProps
NetworkMultipleTargetGroupsFargateService	A Fargate service running on an ECS cluster fronted by a network load balancer.
NetworkMultipleTargetGroupsFargateService.Builder	A fluent builder for NetworkMultipleTargetGroupsFargateService.
NetworkMultipleTargetGroupsFargateServiceProps	The properties for the NetworkMultipleTargetGroupsFargateService service.
NetworkMultipleTargetGroupsFargateServiceProps.Builder	A builder for NetworkMultipleTargetGroupsFargateServiceProps
NetworkMultipleTargetGroupsFargateServiceProps.Jsii$Proxy	An implementation for NetworkMultipleTargetGroupsFargateServiceProps
NetworkMultipleTargetGroupsServiceBase	The base class for NetworkMultipleTargetGroupsEc2Service and NetworkMultipleTargetGroupsFargateService classes.
NetworkMultipleTargetGroupsServiceBaseProps	The properties for the base NetworkMultipleTargetGroupsEc2Service or NetworkMultipleTargetGroupsFargateService service.
NetworkMultipleTargetGroupsServiceBaseProps.Builder	A builder for NetworkMultipleTargetGroupsServiceBaseProps
NetworkMultipleTargetGroupsServiceBaseProps.Jsii$Proxy	An implementation for NetworkMultipleTargetGroupsServiceBaseProps
NetworkTargetProps	Properties to define a network load balancer target group.
NetworkTargetProps.Builder	A builder for NetworkTargetProps
NetworkTargetProps.Jsii$Proxy	An implementation for NetworkTargetProps
QueueProcessingEc2Service	Class to create a queue processing EC2 service.
QueueProcessingEc2Service.Builder	A fluent builder for QueueProcessingEc2Service.
QueueProcessingEc2ServiceProps	The properties for the QueueProcessingEc2Service service.
QueueProcessingEc2ServiceProps.Builder	A builder for QueueProcessingEc2ServiceProps
QueueProcessingEc2ServiceProps.Jsii$Proxy	An implementation for QueueProcessingEc2ServiceProps
QueueProcessingFargateService	Class to create a queue processing Fargate service.
QueueProcessingFargateService.Builder	A fluent builder for QueueProcessingFargateService.
QueueProcessingFargateServiceProps	The properties for the QueueProcessingFargateService service.
QueueProcessingFargateServiceProps.Builder	A builder for QueueProcessingFargateServiceProps
QueueProcessingFargateServiceProps.Jsii$Proxy	An implementation for QueueProcessingFargateServiceProps
QueueProcessingServiceBase	The base class for QueueProcessingEc2Service and QueueProcessingFargateService services.
QueueProcessingServiceBaseProps	The properties for the base QueueProcessingEc2Service or QueueProcessingFargateService service.
QueueProcessingServiceBaseProps.Builder	A builder for QueueProcessingServiceBaseProps
QueueProcessingServiceBaseProps.Jsii$Proxy	An implementation for QueueProcessingServiceBaseProps
ScheduledEc2Task	A scheduled EC2 task that will be initiated off of CloudWatch Events.
ScheduledEc2Task.Builder	A fluent builder for ScheduledEc2Task.
ScheduledEc2TaskDefinitionOptions	The properties for the ScheduledEc2Task using a task definition.
ScheduledEc2TaskDefinitionOptions.Builder	A builder for ScheduledEc2TaskDefinitionOptions
ScheduledEc2TaskDefinitionOptions.Jsii$Proxy	An implementation for ScheduledEc2TaskDefinitionOptions
ScheduledEc2TaskImageOptions	The properties for the ScheduledEc2Task using an image.
ScheduledEc2TaskImageOptions.Builder	A builder for ScheduledEc2TaskImageOptions
ScheduledEc2TaskImageOptions.Jsii$Proxy	An implementation for ScheduledEc2TaskImageOptions
ScheduledEc2TaskProps	The properties for the ScheduledEc2Task task.
ScheduledEc2TaskProps.Builder	A builder for ScheduledEc2TaskProps
ScheduledEc2TaskProps.Jsii$Proxy	An implementation for ScheduledEc2TaskProps
ScheduledFargateTask	A scheduled Fargate task that will be initiated off of CloudWatch Events.
ScheduledFargateTask.Builder	A fluent builder for ScheduledFargateTask.
ScheduledFargateTaskDefinitionOptions	The properties for the ScheduledFargateTask using a task definition.
ScheduledFargateTaskDefinitionOptions.Builder	A builder for ScheduledFargateTaskDefinitionOptions
ScheduledFargateTaskDefinitionOptions.Jsii$Proxy	An implementation for ScheduledFargateTaskDefinitionOptions
ScheduledFargateTaskImageOptions	The properties for the ScheduledFargateTask using an image.
ScheduledFargateTaskImageOptions.Builder	A builder for ScheduledFargateTaskImageOptions
ScheduledFargateTaskImageOptions.Jsii$Proxy	An implementation for ScheduledFargateTaskImageOptions
ScheduledFargateTaskProps	The properties for the ScheduledFargateTask task.
ScheduledFargateTaskProps.Builder	A builder for ScheduledFargateTaskProps
ScheduledFargateTaskProps.Jsii$Proxy	An implementation for ScheduledFargateTaskProps
ScheduledTaskBase	The base class for ScheduledEc2Task and ScheduledFargateTask tasks.
ScheduledTaskBaseProps	The properties for the base ScheduledEc2Task or ScheduledFargateTask task.
ScheduledTaskBaseProps.Builder	A builder for ScheduledTaskBaseProps
ScheduledTaskBaseProps.Jsii$Proxy	An implementation for ScheduledTaskBaseProps
ScheduledTaskImageProps	Example:
ScheduledTaskImageProps.Builder	A builder for ScheduledTaskImageProps
ScheduledTaskImageProps.Jsii$Proxy	An implementation for ScheduledTaskImageProps