# QueueProcessingFargateService

Class to create a queue processing Fargate service.

Extends: Construct › QueueProcessingServiceBase › QueueProcessingFargateService
Implements: IConstruct, IDependable

- Source: [`aws-ecs-patterns/lib/fargate/queue-processing-fargate-service.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-ecs-patterns/lib/fargate/queue-processing-fargate-service.ts#L67)
- Type last changed: v2.116.0 · 22 Dec 2023

## Example

```ts
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

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

## Construct Props

- `assignPublicIp`: boolean = 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`: [CapacityProviderStrategy](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.CapacityProviderStrategy.html)[] = undefined — A list of Capacity Provider strategies used to place a service.

- `circuitBreaker`: [DeploymentCircuitBreaker](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.DeploymentCircuitBreaker.html) = disabled — Whether to enable the deployment circuit breaker.

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

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ICluster.html) — The name of the cluster that hosts the service.

  **Default:** create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

  If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

- `command`: string[] — The command that is passed to the container.

  **Default:** CMD value built into container image.

  If you provide a shell command as a single string, you have to quote command-line arguments.

- `containerName`: string = QueueProcessingContainer — Optional name for the container added.

  This name is not used when `taskDefinition` is provided.

- `cooldown`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — Grace period after scaling activity in seconds.

  **Default:** 300 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`: number = 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`: number = 50 — The target CPU utilization percentage for CPU based scaling strategy when enabled.

- `deploymentController`: [DeploymentController](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.DeploymentController.html) — Specifies which deployment controller to use for the service.

  **Default:** Rolling update (ECS)

  For more information, see
  [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)

- `disableCpuBasedScaling`: boolean = false — Flag to disable CPU based auto scaling strategy on the service.

- `enableECSManagedTags`: boolean = false — Specifies 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)

- `enableExecuteCommand`: boolean = false — Whether ECS Exec should be enabled.

- `enableLogging`: boolean = true — Flag to indicate whether to enable logging.

- `environment`: { [key: string]: string } — The environment variables to pass to the container.

  **Default:** 'QUEUE_NAME: queue.queueName'

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

- `ephemeralStorageGiB`: number — The amount (in GiB) of ephemeral storage to be allocated to the task.

  **Default:** Undefined, in which case, the task will receive 20GiB ephemeral storage.

  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`: string — The name of a family that the task definition is registered to.

  **Default:** Automatically generated name.

  A family groups multiple versions of a task definition.

- `healthCheck`: [HealthCheck](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.HealthCheck.html) — The health check command and associated configuration parameters for the container.

  **Default:** Health check configuration from container.

- `healthCheckGracePeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

  **Default:** defaults to 60 seconds if at least one load balancer is in-use and it is not already set

- `image`: [ContainerImage](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerImage.html) — The image used to start a container.

  **Default:** the image of the task definition is used for Fargate, required otherwise

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

- `logDriver`: [LogDriver](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.LogDriver.html) — The log driver to use.

  **Default:** AwsLogDriver if enableLogging is true

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

  **Default:** default from underlying service.

- `maxReceiveCount`: number = 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`: number = 2 — Maximum capacity to scale to.

- `memoryLimitMiB`: number = 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`: 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.

  **Default:** default from underlying service.

- `minScalingCapacity`: number = 1 — Minimum capacity to scale to.

- `platformVersion`: [FargatePlatformVersion](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargatePlatformVersion.html) = 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
  in the Amazon Elastic Container Service Developer Guide.

- `propagateTags`: [PropagatedTagSource](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PropagatedTagSource.html) = 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`: [IQueue](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.IQueue.html) — A queue for which to process items from.

  **Default:** 'SQSQueue with CloudFormation-generated name'

  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)

- `retentionPeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = 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`: [RuntimePlatform](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.RuntimePlatform.html) — The runtime platform of the task definition.

  **Default:** If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64

- `scalingSteps`: [ScalingInterval](/cdk/api/v2/docs/aws-cdk-lib.aws_applicationautoscaling.ScalingInterval.html)[] — The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.

  **Default:** [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }]

  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)

- `secrets`: { [key: string]: [Secret](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.Secret.html) } — The secret to expose to the container as an environment variable.

  **Default:** No secret environment variables.

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — The security groups to associate with the service.

  **Default:** A new security group is created.

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

- `serviceName`: string — The name of the service.

  **Default:** CloudFormation-generated name.

- `taskDefinition`: [FargateTaskDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinition.html) = 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`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) — The subnets to associate with the service.

  **Default:** Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.

- `visibilityTimeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = 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`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

  **Default:** uses the VPC defined in the cluster or creates a new VPC.

  If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

## Properties

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ICluster.html) (required) — The cluster where your service will be deployed.

- `deadLetterQueue`: [IQueue](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.IQueue.html) — The dead letter queue for the primary SQS queue.

- `environment`: { [key: string]: string } (required) — Environment variables that will include the queue name.

- `logDriver`: [LogDriver](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.LogDriver.html) — The AwsLogDriver to use for logging if logging is enabled.

- `maxCapacity`: number (required) — The maximum number of instances for autoscaling to scale up to.

- `minCapacity`: number (required) — The minimum number of instances for autoscaling to scale down to.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `scalingSteps`: [ScalingInterval](/cdk/api/v2/docs/aws-cdk-lib.aws_applicationautoscaling.ScalingInterval.html)[] (required) — The scaling interval for autoscaling based off an SQS Queue size.

- `secrets`: { [key: string]: [Secret](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.Secret.html) } — The secret environment variables.

- `service`: [FargateService](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) (required) — The Fargate service in this construct.

- `sqsQueue`: [IQueue](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.IQueue.html) (required) — The SQS queue that the service will process from.

- `taskDefinition`: [FargateTaskDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinition.html) (required) — The Fargate task definition in this construct.

## Methods

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining