NetworkMultipleTargetGroupsEc2Service
An EC2 service running on an ECS cluster fronted by a network load balancer.
Import
import { NetworkMultipleTargetGroupsEc2Service } from 'aws-cdk-lib/aws-ecs-patterns';Or use the module namespace:
import * as ecs_patterns from 'aws-cdk-lib/aws-ecs-patterns';
// ecs_patterns.NetworkMultipleTargetGroupsEc2ServiceProperties
Configuration passed to the constructor as NetworkMultipleTargetGroupsEc2ServiceProps.
cpuOptionalnumberThe minimum number of CPU units to reserve for the container. Valid values, which determines your range of valid values for the memory parameter:
Default: - No minimum CPU units reserved.
memoryLimitMiBOptionalnumberThe amount (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated. At least one of memoryLimitMiB and memoryReservationMiB is required.
Default: - No memory limit.
memoryReservationMiBOptionalnumberThe soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. At least one of memoryLimitMiB and memoryReservationMiB is required. Note that this setting will be ignored if TaskImagesOptions is specified.
Default: - No memory reserved.
placementConstraintsOptionalPlacementConstraint[]The placement constraints to use for tasks in the service. For more information, see [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
Default: - No constraints.
placementStrategiesOptionalPlacementStrategy[]The placement strategies to use for tasks in the service. For more information, see [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
Default: - No strategies.
taskDefinitionOptionalEc2TaskDefinitionThe task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified. [disable-awslint:ref-via-interface]
Default: - none
12 properties inherited from NetworkMultipleTargetGroupsServiceBaseProps
cloudMapOptionsOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsCloudMapOptionsThe options for configuring an Amazon ECS service to use service discovery.
Default: - AWS Cloud Map service discovery is not enabled.
clusterOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsIClusterThe name of the cluster that hosts the service. If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
desiredCountOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsnumberThe desired number of instantiations of the task definition to keep running on the service. The minimum value is 1
Default: - The default is 1 for all new services and uses the existing service's desired count
when updating an existing service.
enableECSManagedTagsOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsbooleanSpecifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
Default: false
enableExecuteCommandOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsbooleanWhether ECS Exec should be enabled.
Default: - false
healthCheckGracePeriodOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsDurationThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
loadBalancersOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsNetworkLoadBalancerProps[]The network load balancer that will serve traffic to the service.
Default: - a new load balancer with a listener will be created.
propagateTagsOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsPropagatedTagSourceSpecifies whether to propagate the tags from the task definition or the service to the tasks in the service. Tags can only be propagated to the tasks within the service during service creation.
Default: - none
serviceNameOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsstringName of the service.
Default: - CloudFormation-generated name.
targetGroupsOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsNetworkTargetProps[]Properties to specify NLB target groups.
Default: - default portMapping registered as target group and attached to the first defined listener
taskImageOptionsOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsNetworkLoadBalancedTaskImagePropsThe properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified.
Default: - none
vpcOptionalinherited from NetworkMultipleTargetGroupsServiceBasePropsIVpcThe VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.
Default: - uses the VPC defined in the cluster or creates a new VPC.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-ecs-patternsRelated Constructs
- ApplicationLoadBalancedEc2ServiceL2
- ApplicationLoadBalancedFargateServiceL2
- ApplicationMultipleTargetGroupsEc2ServiceL2
- ApplicationMultipleTargetGroupsFargateServiceL2
- NetworkLoadBalancedEc2ServiceL2
- NetworkLoadBalancedFargateServiceL2
- NetworkMultipleTargetGroupsFargateServiceL2
- QueueProcessingEc2ServiceL2
- QueueProcessingFargateServiceL2
- ScheduledEc2TaskL2