aws-cdk-lib.aws_ecs_patterns.QueueProcessingEc2Service

class QueueProcessingEc2Service (construct)

LanguageType name
.NETAmazon.CDK.AWS.ECS.Patterns.QueueProcessingEc2Service
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#QueueProcessingEc2Service
Javasoftware.amazon.awscdk.services.ecs.patterns.QueueProcessingEc2Service
Pythonaws_cdk.aws_ecs_patterns.QueueProcessingEc2Service
TypeScript (source)aws-cdk-lib » aws_ecs_patterns » QueueProcessingEc2Service

Implements IConstruct, IDependable

Class to create a queue processing EC2 service.

Example

declare const cluster: ecs.Cluster;
const queueProcessingEc2Service = new ecsPatterns.QueueProcessingEc2Service(this, 'Service', {
  cluster,
  memoryLimitMiB: 1024,
  image: ecs.ContainerImage.fromRegistry('test'),
  command: ["-c", "4", "amazon.com"],
  enableLogging: false,
  desiredTaskCount: 2,
  environment: {
    TEST_ENVIRONMENT_VARIABLE1: "test environment variable 1 value",
    TEST_ENVIRONMENT_VARIABLE2: "test environment variable 2 value",
  },
  maxScalingCapacity: 5,
  containerName: 'test',
});

Initializer

new QueueProcessingEc2Service(scope: Construct, id: string, props: QueueProcessingEc2ServiceProps)

Parameters

  • scope Construct
  • id string
  • props QueueProcessingEc2ServiceProps

Constructs a new instance of the QueueProcessingEc2Service class.

Construct Props

NameTypeDescription
imageContainerImageThe image used to start a container.
capacityProviderStrategies?CapacityProviderStrategy[]A list of Capacity Provider strategies used to place a service.
circuitBreaker?DeploymentCircuitBreakerWhether to enable the deployment circuit breaker.
cluster?IClusterThe name of the cluster that hosts the service.
command?string[]The command that is passed to the container.
containerName?stringOptional name for the container added.
cpu?numberThe number of cpu units used by the task.
deploymentController?DeploymentControllerSpecifies which deployment controller to use for the service.
enableECSManagedTags?booleanSpecifies whether to enable Amazon ECS managed tags for the tasks within the service.
enableExecuteCommand?booleanWhether ECS Exec should be enabled.
enableLogging?booleanFlag to indicate whether to enable logging.
environment?{ [string]: string }The environment variables to pass to the container.
family?stringThe name of a family that the task definition is registered to.
gpuCount?numberGpu count for container in task definition.
logDriver?LogDriverThe log driver to use.
maxHealthyPercent?numberThe 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.
maxReceiveCount?numberThe maximum number of times that a message can be received by consumers.
maxScalingCapacity?numberMaximum capacity to scale to.
memoryLimitMiB?numberThe hard limit (in MiB) of memory to present to the container.
memoryReservationMiB?numberThe soft limit (in MiB) of memory to reserve for the container.
minHealthyPercent?numberThe 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.
minScalingCapacity?numberMinimum capacity to scale to.
placementConstraints?PlacementConstraint[]The placement constraints to use for tasks in the service.
placementStrategies?PlacementStrategy[]The placement strategies to use for tasks in the service.
propagateTags?PropagatedTagSourceSpecifies whether to propagate the tags from the task definition or the service to the tasks in the service.
queue?IQueueA queue for which to process items from.
retentionPeriod?DurationThe number of seconds that Dead Letter Queue retains a message.
scalingSteps?ScalingInterval[]The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
secrets?{ [string]: Secret }The secret to expose to the container as an environment variable.
serviceName?stringThe name of the service.
visibilityTimeout?DurationTimeout of processing a single message.
vpc?IVpcThe VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

image

Type: ContainerImage

The image used to start a container.


capacityProviderStrategies?

Type: CapacityProviderStrategy[] (optional, default: undefined)

A list of Capacity Provider strategies used to place a service.


circuitBreaker?

Type: DeploymentCircuitBreaker (optional, default: disabled)

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.


cluster?

Type: ICluster (optional, default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.)

The 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.


command?

Type: string[] (optional, default: CMD value built into container image.)

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.


containerName?

Type: string (optional, default: QueueProcessingContainer)

Optional name for the container added.


cpu?

Type: number (optional, default: none)

The 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.


deploymentController?

Type: DeploymentController (optional, default: Rolling update (ECS))

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types


enableECSManagedTags?

Type: boolean (optional, default: false)

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources


enableExecuteCommand?

Type: boolean (optional, default: false)

Whether ECS Exec should be enabled.


enableLogging?

Type: boolean (optional, default: true)

Flag to indicate whether to enable logging.


environment?

Type: { [string]: string } (optional, default: 'QUEUE_NAME: queue.queueName')

The environment variables to pass to the container.

The variable QUEUE_NAME with value queue.queueName will always be passed.


family?

Type: string (optional, default: Automatically generated name.)

The name of a family that the task definition is registered to.

A family groups multiple versions of a task definition.


gpuCount?

Type: number (optional, default: No GPUs assigned.)

Gpu count for container in task definition.

Set this if you want to use gpu based instances.


logDriver?

Type: LogDriver (optional, default: AwsLogDriver if enableLogging is true)

The log driver to use.


maxHealthyPercent?

Type: number (optional, default: default from underlying service.)

The 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.


maxReceiveCount?

Type: number (optional, default: 3)

The 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.


maxScalingCapacity?

Type: number (optional, default: If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is (desiredTaskCount * 2); if true, the default is 2.)

Maximum capacity to scale to.


memoryLimitMiB?

Type: number (optional, default: No memory limit.)

The 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.


memoryReservationMiB?

Type: number (optional, default: No memory reserved.)

The 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.


minHealthyPercent?

Type: number (optional, default: default from underlying service.)

The 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.


minScalingCapacity?

Type: number (optional, default: If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 1.)

Minimum capacity to scale to.


placementConstraints?

Type: PlacementConstraint[] (optional, default: No constraints.)

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.


placementStrategies?

Type: PlacementStrategy[] (optional, default: No strategies.)

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.


propagateTags?

Type: PropagatedTagSource (optional, default: none)

Specifies 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.


queue?

Type: IQueue (optional, default: 'SQSQueue with CloudFormation-generated name')

A 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


retentionPeriod?

Type: Duration (optional, default: Duration.days(14))

The number of seconds that Dead Letter Queue retains a message.

If the queue construct is specified, retentionPeriod should be omitted.


scalingSteps?

Type: ScalingInterval[] (optional, default: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }])

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


secrets?

Type: { [string]: Secret } (optional, default: No secret environment variables.)

The secret to expose to the container as an environment variable.


serviceName?

Type: string (optional, default: CloudFormation-generated name.)

The name of the service.


visibilityTimeout?

Type: Duration (optional, default: Duration.seconds(30))

Timeout 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.


vpc?

Type: IVpc (optional, default: uses the VPC defined in the cluster or creates a new VPC.)

The 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.

Properties

NameTypeDescription
clusterIClusterThe cluster where your service will be deployed.
environment{ [string]: string }Environment variables that will include the queue name.
maxCapacitynumberThe maximum number of instances for autoscaling to scale up to.
minCapacitynumberThe minimum number of instances for autoscaling to scale down to.
nodeNodeThe tree node.
scalingStepsScalingInterval[]The scaling interval for autoscaling based off an SQS Queue size.
serviceEc2ServiceThe EC2 service in this construct.
sqsQueueIQueueThe SQS queue that the service will process from.
taskDefinitionEc2TaskDefinitionThe EC2 task definition in this construct.
deadLetterQueue?IQueueThe dead letter queue for the primary SQS queue.
logDriver?LogDriverThe AwsLogDriver to use for logging if logging is enabled.
secrets?{ [string]: Secret }The secret environment variables.

cluster

Type: ICluster

The cluster where your service will be deployed.


environment

Type: { [string]: string }

Environment variables that will include the queue name.


maxCapacity

Type: number

The maximum number of instances for autoscaling to scale up to.


minCapacity

Type: number

The minimum number of instances for autoscaling to scale down to.


node

Type: Node

The tree node.


scalingSteps

Type: ScalingInterval[]

The scaling interval for autoscaling based off an SQS Queue size.


service

Type: Ec2Service

The EC2 service in this construct.


sqsQueue

Type: IQueue

The SQS queue that the service will process from.


taskDefinition

Type: Ec2TaskDefinition

The EC2 task definition in this construct.


deadLetterQueue?

Type: IQueue (optional)

The dead letter queue for the primary SQS queue.


logDriver?

Type: LogDriver (optional)

The AwsLogDriver to use for logging if logging is enabled.


secrets?

Type: { [string]: Secret } (optional)

The secret environment variables.

Methods

NameDescription
toString()Returns a string representation of this construct.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.