class QueueProcessingFargateService (construct)

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

Implements IConstruct, IDependable

Class to create a queue processing Fargate service.

Example

declare const cluster: ecs.Cluster;
cluster.enableFargateCapacityProviders();

const queueProcessingFargateService = new ecsPatterns.QueueProcessingFargateService(this, 'Service', {
  cluster,
  memoryLimitMiB: 512,
  image: ecs.ContainerImage.fromRegistry('test'),
  minHealthyPercent: 100,
  capacityProviderStrategies: [
    {
      capacityProvider: 'FARGATE_SPOT',
      weight: 2,
    },
    {
      capacityProvider: 'FARGATE',
      weight: 1,
    },
  ],
});

Initializer

new QueueProcessingFargateService(scope: Construct, id: string, props?: QueueProcessingFargateServiceProps)

Parameters

scope Construct
id string
props QueueProcessingFargateServiceProps

Constructs a new instance of the QueueProcessingFargateService class.

Construct Props

Name	Type	Description
assignPublicIp?	`boolean`	Specifies whether the task's elastic network interface receives a public IP address.
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.
ephemeralStorageGiB?	`number`	The amount (in GiB) of ephemeral storage to be allocated to the task.
family?	`string`	The name of a family that the task definition is registered to.
healthCheck?	`HealthCheck`	The health check command and associated configuration parameters for the container.
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 amount (in MiB) of memory used by the task.
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.
platformVersion?	`FargatePlatformVersion`	The platform version on which to run your 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.
runtimePlatform?	`RuntimePlatform`	The runtime platform of the task definition.
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.
securityGroups?	`ISecurityGroup[]`	The security groups to associate with the service.
serviceName?	`string`	The name of the service.
taskDefinition?	`FargateTaskDefinition`	The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
taskSubnets?	`SubnetSelection`	The subnets to associate with 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.

assignPublicIp?

Type: boolean (optional, default: false)

Specifies whether the task's elastic network interface receives a public IP address.

If true, each task will receive a public IP address.

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.

This name is not used when taskDefinition is provided.

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: 256)

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

8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments

16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB 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.

ephemeralStorageGiB?

Type: number (optional, default: Undefined, in which case, the task will receive 20GiB ephemeral storage.)

The amount (in GiB) of ephemeral storage to be allocated to the task.

The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

Only supported in Fargate platform version 1.4.0 or later.

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.

healthCheck?

Type: HealthCheck (optional, default: Health check configuration from container.)

The health check command and associated configuration parameters for the container.

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: 512)

The amount (in MiB) of memory used by the task.

This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

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.

platformVersion?

Type: FargatePlatformVersion (optional, default: Latest)

The platform version on which to run your service.

If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

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.

runtimePlatform?

Type: RuntimePlatform (optional, default: If the property is undefined, operatingSystemFamily is LINUX and cpuArchitecture is X86_64)

The runtime platform of the task definition.

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.

securityGroups?

Type: ISecurityGroup[] (optional, default: A new security group is created.)

The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

serviceName?

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

The name of the service.

taskDefinition?

Type: FargateTaskDefinition (optional, default: none)

The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.

[disable-awslint:ref-via-interface]

taskSubnets?

Type: SubnetSelection (optional, default: Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.)

The subnets to associate with 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

Name	Type	Description
cluster	`ICluster`	The cluster where your service will be deployed.
environment	`{ [string]: string }`	Environment variables that will include the queue name.
maxCapacity	`number`	The maximum number of instances for autoscaling to scale up to.
minCapacity	`number`	The minimum number of instances for autoscaling to scale down to.
node	`Node`	The tree node.
scalingSteps	`ScalingInterval[]`	The scaling interval for autoscaling based off an SQS Queue size.
service	`FargateService`	The Fargate service in this construct.
sqsQueue	`IQueue`	The SQS queue that the service will process from.
taskDefinition	`FargateTaskDefinition`	The Fargate task definition in this construct.
deadLetterQueue?	`IQueue`	The dead letter queue for the primary SQS queue.
logDriver?	`LogDriver`	The 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: FargateService

The Fargate service in this construct.

sqsQueue

Type: IQueue

The SQS queue that the service will process from.

taskDefinition

Type: FargateTaskDefinition

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

Name	Description
toString()	Returns a string representation of this construct.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.