QueueProcessingEc2Service
Class to create a queue processing EC2 service.
Import
import { QueueProcessingEc2Service } 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.QueueProcessingEc2ServiceProperties
Configuration passed to the constructor as QueueProcessingEc2ServiceProps.
containerNameOptionalstringOptional name for the container added.
Default: - QueueProcessingContainer
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
gpuCountOptionalnumberGpu count for container in task definition. Set this if you want to use gpu based instances.
Default: - No GPUs assigned.
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 for non-Fargate services.
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 for non-Fargate services.
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.
28 properties inherited from QueueProcessingServiceBaseProps
capacityProviderStrategiesOptionalinherited from QueueProcessingServiceBasePropsCapacityProviderStrategy[]A list of Capacity Provider strategies used to place a service.
Default: - undefined
circuitBreakerOptionalinherited from QueueProcessingServiceBasePropsDeploymentCircuitBreakerWhether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
clusterOptionalinherited from QueueProcessingServiceBasePropsIClusterThe 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.
commandOptionalinherited from QueueProcessingServiceBasePropsstring[]The command that is passed to the container. If you provide a shell command as a single string, you have to quote command-line arguments.
Default: - CMD value built into container image.
cooldownOptionalinherited from QueueProcessingServiceBasePropsDurationGrace period after scaling activity in seconds. Subsequent scale outs during the cooldown period are squashed so that only the biggest scale out happens. Subsequent scale ins during the cooldown period are ignored.
Default: 300 seconds
cpuTargetUtilizationPercentOptionalinherited from QueueProcessingServiceBasePropsnumberThe target CPU utilization percentage for CPU based scaling strategy when enabled.
Default: - 50
deploymentControllerOptionalinherited from QueueProcessingServiceBasePropsDeploymentControllerSpecifies 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)
disableCpuBasedScalingOptionalinherited from QueueProcessingServiceBasePropsbooleanFlag to disable CPU based auto scaling strategy on the service.
Default: - false
enableECSManagedTagsOptionalinherited from QueueProcessingServiceBasePropsbooleanSpecifies 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 QueueProcessingServiceBasePropsbooleanWhether ECS Exec should be enabled.
Default: - false
enableLoggingOptionalinherited from QueueProcessingServiceBasePropsbooleanFlag to indicate whether to enable logging.
Default: true
environmentOptionalinherited from QueueProcessingServiceBaseProps{ [key: string]: string }The environment variables to pass to the container. The variable `QUEUE_NAME` with value `queue.queueName` will always be passed.
Default: 'QUEUE_NAME: queue.queueName'
familyOptionalinherited from QueueProcessingServiceBasePropsstringThe name of a family that the task definition is registered to. A family groups multiple versions of a task definition.
Default: - Automatically generated name.
imageOptionalinherited from QueueProcessingServiceBasePropsContainerImageThe image used to start a container. For `QueueProcessingFargateService`, either `image` or `taskDefinition` must be specified, but not both. For `QueueProcessingEc2Service`, `image` is required.
Default: - the image of the task definition is used for Fargate, required otherwise
logDriverOptionalinherited from QueueProcessingServiceBasePropsLogDriverThe log driver to use.
Default: - AwsLogDriver if enableLogging is true
maxHealthyPercentOptionalinherited from QueueProcessingServiceBasePropsnumberThe 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: - default from underlying service.
maxReceiveCountOptionalinherited from QueueProcessingServiceBasePropsnumberThe maximum number of times that a message can be received by consumers. When this value is exceeded for a message the message will be automatically sent to the Dead Letter Queue. If the queue construct is specified, maxReceiveCount should be omitted.
Default: 3
maxScalingCapacityOptionalinherited from QueueProcessingServiceBasePropsnumberMaximum capacity to scale to.
Default: 2
minHealthyPercentOptionalinherited from QueueProcessingServiceBasePropsnumberThe 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: - default from underlying service.
minScalingCapacityOptionalinherited from QueueProcessingServiceBasePropsnumberMinimum capacity to scale to.
Default: 1
propagateTagsOptionalinherited from QueueProcessingServiceBasePropsPropagatedTagSourceSpecifies 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
queueOptionalinherited from QueueProcessingServiceBasePropsIQueueA queue for which to process items from. If specified and this is a FIFO queue, the queue name must end in the string '.fifo'. See [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)
Default: 'SQSQueue with CloudFormation-generated name'
retentionPeriodOptionalinherited from QueueProcessingServiceBasePropsDurationThe number of seconds that Dead Letter Queue retains a message. If the queue construct is specified, retentionPeriod should be omitted.
Default: Duration.days(14)
scalingStepsOptionalinherited from QueueProcessingServiceBasePropsScalingInterval[]The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric. Maps a range of metric values to a particular scaling behavior. See [Simple and Step Scaling Policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html)
Default: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }]
secretsOptionalinherited from QueueProcessingServiceBaseProps{ [key: string]: Secret }The secret to expose to the container as an environment variable.
Default: - No secret environment variables.
serviceNameOptionalinherited from QueueProcessingServiceBasePropsstringThe name of the service.
Default: - CloudFormation-generated name.
visibilityTimeoutOptionalinherited from QueueProcessingServiceBasePropsDurationTimeout of processing a single message. After dequeuing, the processor has this much time to handle the message and delete it from the queue before it becomes visible again for dequeueing by another processor. Values must be between 0 and (12 hours). If the queue construct is specified, visibilityTimeout should be omitted.
Default: Duration.seconds(30)
vpcOptionalinherited from QueueProcessingServiceBasePropsIVpcThe 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
- NetworkMultipleTargetGroupsEc2ServiceL2
- NetworkMultipleTargetGroupsFargateServiceL2
- QueueProcessingFargateServiceL2
- ScheduledEc2TaskL2