interface QueueProcessingEc2ServiceProps

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.Patterns.QueueProcessingEc2ServiceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#QueueProcessingEc2ServiceProps`
Java	`software.amazon.awscdk.services.ecs.patterns.QueueProcessingEc2ServiceProps`
Python	`aws_cdk.aws_ecs_patterns.QueueProcessingEc2ServiceProps`
TypeScript (source)	`aws-cdk-lib` » `aws_ecs_patterns` » `QueueProcessingEc2ServiceProps`

The properties for the QueueProcessingEc2Service 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',
});

Properties

Name	Type	Description
capacityProviderStrategies?	`CapacityProviderStrategy[]`	A list of Capacity Provider strategies used to place a service.
circuitBreaker?	`DeploymentCircuitBreaker`	Whether to enable the deployment circuit breaker.
cluster?	`ICluster`	The name of the cluster that hosts the service.
command?	`string[]`	The command that is passed to the container.
containerName?	`string`	Optional name for the container added.
cooldown?	`Duration`	Grace period after scaling activity in seconds.
cpu?	`number`	The number of cpu units used by the task.
cpuTargetUtilizationPercent?	`number`	The target CPU utilization percentage for CPU based scaling strategy when enabled.
deploymentController?	`DeploymentController`	Specifies which deployment controller to use for the service.
disableCpuBasedScaling?	`boolean`	Flag to disable CPU based auto scaling strategy on the service.
enableECSManagedTags?	`boolean`	Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
enableExecuteCommand?	`boolean`	Whether ECS Exec should be enabled.
enableLogging?	`boolean`	Flag to indicate whether to enable logging.
environment?	`{ [string]: string }`	The environment variables to pass to the container.
family?	`string`	The name of a family that the task definition is registered to.
gpuCount?	`number`	Gpu count for container in task definition.
image?	`ContainerImage`	The image used to start a container.
logDriver?	`LogDriver`	The log driver to use.
maxHealthyPercent?	`number`	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?	`number`	The maximum number of times that a message can be received by consumers.
maxScalingCapacity?	`number`	Maximum capacity to scale to.
memoryLimitMiB?	`number`	The hard limit (in MiB) of memory to present to the container.
memoryReservationMiB?	`number`	The soft limit (in MiB) of memory to reserve for the container.
minHealthyPercent?	`number`	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?	`number`	Minimum 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?	`PropagatedTagSource`	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
queue?	`IQueue`	A queue for which to process items from.
retentionPeriod?	`Duration`	The 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?	`string`	The name of the service.
visibilityTimeout?	`Duration`	Timeout of processing a single message.
vpc?	`IVpc`	The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

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.

cooldown?

Type: Duration (optional, default: 300 seconds)

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

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.

cpuTargetUtilizationPercent?

Type: number (optional, default: 50)

The target CPU utilization percentage for CPU based scaling strategy when enabled.

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

disableCpuBasedScaling?

Type: boolean (optional, default: false)

Flag to disable CPU based auto scaling strategy on the service.

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.

image?

Type: ContainerImage (optional, default: the image of the task definition is used for Fargate, required otherwise)

The image used to start a container.

For QueueProcessingFargateService, either image or taskDefinition must be specified, but not both. For QueueProcessingEc2Service, image is required.

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