aws-cdk-lib.aws_ecs_patterns.QueueProcessingFargateServiceProps

interface QueueProcessingFargateServiceProps

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

The properties for the QueueProcessingFargateService service.

Example

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

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

Properties

NameTypeDescription
imageContainerImageThe image used to start a container.
assignPublicIp?booleanSpecifies 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?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.
healthCheck?HealthCheckThe health check command and associated configuration parameters for the container.
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 amount (in MiB) of memory used by the task.
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.
platformVersion?FargatePlatformVersionThe platform version on which to run your 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.
runtimePlatform?RuntimePlatformThe 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?stringThe name of the service.
taskDefinition?FargateTaskDefinitionThe task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
taskSubnets?SubnetSelectionThe subnets to associate with 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.


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.


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.


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.


healthCheck?

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

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


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


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.