NetworkLoadBalancedEc2Service
An EC2 service running on an ECS cluster fronted by a network load balancer.
Import
import { NetworkLoadBalancedEc2Service } 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.NetworkLoadBalancedEc2ServiceProperties
Configuration passed to the constructor as NetworkLoadBalancedEc2ServiceProps.
cpuOptionalnumberThe number of cpu units used by the task. Valid values, which determines your range of valid values for the memory parameter: 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments This default is set in the underlying FargateTaskDefinition construct.
Default: none
memoryLimitMiBOptionalnumberThe hard limit (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 contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first. At least one of memoryLimitMiB and memoryReservationMiB is required.
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. TaskDefinition or TaskImageOptions must be specified, but not both.. [disable-awslint:ref-via-interface]
Default: - none
23 properties inherited from NetworkLoadBalancedServiceBaseProps
capacityProviderStrategiesOptionalinherited from NetworkLoadBalancedServiceBasePropsCapacityProviderStrategy[]A list of Capacity Provider strategies used to place a service.
Default: - undefined
circuitBreakerOptionalinherited from NetworkLoadBalancedServiceBasePropsDeploymentCircuitBreakerWhether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
cloudMapOptionsOptionalinherited from NetworkLoadBalancedServiceBasePropsCloudMapOptionsThe options for configuring an Amazon ECS service to use service discovery.
Default: - AWS Cloud Map service discovery is not enabled.
clusterOptionalinherited from NetworkLoadBalancedServiceBasePropsIClusterThe 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.
deploymentControllerOptionalinherited from NetworkLoadBalancedServiceBasePropsDeploymentControllerSpecifies which deployment controller to use for the service. For more information, see [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)
Default: - Rolling update (ECS)
desiredCountOptionalinherited from NetworkLoadBalancedServiceBasePropsnumberThe 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.
domainNameOptionalinherited from NetworkLoadBalancedServiceBasePropsstringThe domain name for the service, e.g. "api.example.com.".
Default: - No domain name.
domainZoneOptionalinherited from NetworkLoadBalancedServiceBasePropsIHostedZoneThe Route53 hosted zone for the domain, e.g. "example.com.".
Default: - No Route53 hosted domain zone.
enableECSManagedTagsOptionalinherited from NetworkLoadBalancedServiceBasePropsbooleanSpecifies 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 NetworkLoadBalancedServiceBasePropsbooleanWhether ECS Exec should be enabled.
Default: - false
healthCheckGracePeriodOptionalinherited from NetworkLoadBalancedServiceBasePropsDurationThe 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
ipAddressTypeOptionalinherited from NetworkLoadBalancedServiceBasePropsIpAddressTypeThe type of IP addresses to use. If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4.
Default: IpAddressType.IPV4
listenerCertificateOptionalinherited from NetworkLoadBalancedServiceBasePropsIListenerCertificateListener certificate list of ACM cert ARNs. If you provide a certificate, the listener's protocol will be TLS. If not, the listener's protocol will be TCP.
Default: - none
listenerPortOptionalinherited from NetworkLoadBalancedServiceBasePropsnumberListener port of the network load balancer that will serve traffic to the service.
Default: 80 or 443 with listenerCertificate provided
loadBalancerOptionalinherited from NetworkLoadBalancedServiceBasePropsINetworkLoadBalancerThe network load balancer that will serve traffic to the service. If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes(). [disable-awslint:ref-via-interface]
Default: - a new load balancer will be created.
maxHealthyPercentOptionalinherited from NetworkLoadBalancedServiceBasePropsnumberThe maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
Default: - 100 if daemon, otherwise 200
minHealthyPercentOptionalinherited from NetworkLoadBalancedServiceBasePropsnumberThe minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
Default: - 0 if daemon, otherwise 50
propagateTagsOptionalinherited from NetworkLoadBalancedServiceBasePropsPropagatedTagSourceSpecifies 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
publicLoadBalancerOptionalinherited from NetworkLoadBalancedServiceBasePropsbooleanDetermines whether the Load Balancer will be internet-facing.
Default: true
recordTypeOptionalinherited from NetworkLoadBalancedServiceBasePropsNetworkLoadBalancedServiceRecordTypeSpecifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. This is useful if you need to work with DNS systems that do not support alias records.
Default: NetworkLoadBalancedServiceRecordType.ALIAS
serviceNameOptionalinherited from NetworkLoadBalancedServiceBasePropsstringThe name of the service.
Default: - CloudFormation-generated name.
taskImageOptionsOptionalinherited from NetworkLoadBalancedServiceBasePropsNetworkLoadBalancedTaskImageOptionsThe properties required to create a new task definition. One of taskImageOptions or taskDefinition must be specified.
Default: - none
vpcOptionalinherited from NetworkLoadBalancedServiceBasePropsIVpcThe 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
- NetworkLoadBalancedFargateServiceL2
- NetworkMultipleTargetGroupsEc2ServiceL2
- NetworkMultipleTargetGroupsFargateServiceL2
- QueueProcessingEc2ServiceL2
- QueueProcessingFargateServiceL2
- ScheduledEc2TaskL2