# Queue

A new Amazon SQS queue.

Extends: Construct › Resource › QueueBase › Queue
Implements: IResource, IEncryptedResource, IQueue, IEnvironmentAware, IQueueRef, IConstruct, IDependable

- CloudFormation: [`AWS::SQS::Queue`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-sqs-queue.html)
- L1 type: [`CfnQueue`](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.CfnQueue.html)
- Source: [`aws-sqs/lib/queue.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-sqs/lib/queue.ts#L290)
- Type last changed: v2.196.0 · 16 May 2025

## Example

```ts
import * as redshiftserverless from 'aws-cdk-lib/aws-redshiftserverless'

declare const workgroup: redshiftserverless.CfnWorkgroup;

const rule = new events.Rule(this, 'Rule', {
  schedule: events.Schedule.rate(cdk.Duration.hours(1)),
});

const dlq = new sqs.Queue(this, 'DeadLetterQueue');

rule.addTarget(new targets.RedshiftQuery(workgroup.attrWorkgroupWorkgroupArn, {
  database: 'dev',
  deadLetterQueue: dlq,
  sql: ['SELECT * FROM foo','SELECT * FROM baz'],
}));
```

## Initializer

```ts
new Queue(scope: Construct, id: string, props?: QueueProps)
```

## Construct Props

- `contentBasedDeduplication`: boolean = false — Specifies whether to enable content-based deduplication.

  During the deduplication interval (5 minutes), Amazon SQS treats
  messages that are sent with identical content (excluding attributes) as
  duplicates and delivers only one copy of the message.

  If you don't enable content-based deduplication and you want to deduplicate
  messages, provide an explicit deduplication ID in your SendMessage() call.

  (Only applies to FIFO queues.)

- `dataKeyReuse`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.minutes(5) — The length of time that Amazon SQS reuses a data key before calling KMS again.

  The value must be an integer between 60 (1 minute) and 86,400 (24
  hours). The default is 300 (5 minutes).

- `deadLetterQueue`: [DeadLetterQueue](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.DeadLetterQueue.html) — Send messages to this queue if they were unsuccessfully dequeued a number of times.

  **Default:** no dead-letter queue

- `deduplicationScope`: [DeduplicationScope](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.DeduplicationScope.html) = DeduplicationScope.QUEUE — For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.

  (Only applies to FIFO queues.)

- `deliveryDelay`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = 0 — The time in seconds that the delivery of all messages in the queue is delayed.

  You can specify an integer value of 0 to 900 (15 minutes). The default
  value is 0.

- `encryption`: [QueueEncryption](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueEncryption.html) — Whether the contents of the queue are encrypted, and by what type of key.

  **Default:** SQS_MANAGED (SSE-SQS) for newly created queues

  Be aware that encryption is not available in all regions, please see the docs
  for current availability details.

- `encryptionMasterKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — External KMS key to use for queue encryption.

  **Default:** If encryption is set to KMS and not specified, a key will be created.

  Individual messages will be encrypted using data keys. The data keys in
  turn will be encrypted using this key, and reused for a maximum of
  `dataKeyReuseSecs` seconds.

  If the 'encryptionMasterKey' property is set, 'encryption' type will be
  implicitly set to "KMS".

- `enforceSSL`: boolean = false — Enforce encryption of data in transit.

- `fifo`: boolean — Whether this a first-in-first-out (FIFO) queue.

  **Default:** false, unless queueName ends in '.fifo' or 'contentBasedDeduplication' is true.

- `fifoThroughputLimit`: [FifoThroughputLimit](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.FifoThroughputLimit.html) = FifoThroughputLimit.PER_QUEUE — For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.

  (Only applies to FIFO queues.)

- `maxMessageSizeBytes`: number = 1MiB — The limit of how many bytes that a message can contain before Amazon SQS rejects it.

  You can specify an integer value from 1024 bytes (1 KiB) to 1048576 bytes
  (1 MiB). The default value is 1048576 (1 MiB).

- `queueName`: string — A name for the queue.

  **Default:** CloudFormation-generated name

  If specified and this is a FIFO queue, must end in the string '.fifo'.

- `receiveMessageWaitTime`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = 0 — Default wait time for ReceiveMessage calls.

  Does not wait if set to 0, otherwise waits this amount of seconds
  by default for messages to arrive.

  For more information, see Amazon SQS Long Poll.

- `redriveAllowPolicy`: [RedriveAllowPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.RedriveAllowPolicy.html) — The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues.

  **Default:** All source queues can designate this queue as their dead-letter queue.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.DESTROY — Policy to apply when the queue is removed from the stack.

  Even though queues are technically stateful, their contents are transient and it
  is common to add and remove Queues while rearchitecting your application. The
  default is therefore `DESTROY`. Change it to `RETAIN` if the messages are so
  valuable that accidentally losing them would be unacceptable.

- `retentionPeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.days(4) — The number of seconds that Amazon SQS retains a message.

  You can specify an integer value from 60 seconds (1 minute) to 1209600
  seconds (14 days). The default value is 345600 seconds (4 days).

- `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 from 0 to 43200 seconds (12 hours). If you don't specify
  a value, AWS CloudFormation uses the default value of 30 seconds.

## Properties

- `deadLetterQueue`: [DeadLetterQueue](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.DeadLetterQueue.html) — If this queue is configured with a dead-letter queue, this is the dead-letter queue settings.

- `encryptionMasterKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — If this queue is encrypted, this is the KMS key.

- `encryptionType`: [QueueEncryption](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueEncryption.html) — Whether the contents of the queue are encrypted, and by what type of key.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `fifo`: boolean (required) — Whether this queue is an Amazon SQS FIFO queue.

  If false, this is a standard queue.

- `grants`: [QueueGrants](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueGrants.html) (required) — Collection of grant methods for a Queue.

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

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `queueArn`: string (required) — The ARN of this queue.

- `queueName`: string (required) — The name of this queue.

- `queueRef`: [QueueReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_sqs.QueueReference.html) (required) — A reference to a Queue resource.

- `queueUrl`: string (required) — The URL of this queue.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult` — Adds a statement to the IAM resource policy associated with this queue.

  If this queue was created in this stack (`new Queue`), a queue policy
  will be automatically created upon the first call to `addToPolicy`. If
  the queue is imported (`Queue.import`), then this is a no-op.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromQueueArn(scope: Construct, id: string, queueArn: string): IQueue` (static) — Import an existing SQS queue provided an ARN.

  **Parameters**

  - `scope` — The parent creating construct.
  - `id` — The construct's name.
  - `queueArn` — queue ARN (i.e. arn:aws:sqs:us-east-2:444455556666:queue1).

- `fromQueueAttributes(scope: Construct, id: string, attrs: QueueAttributes): IQueue` (static) — Import an existing queue.

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — Principal to grant right to.
  - `actions` — The actions to grant.

- `grantConsumeMessages(grantee: IGrantable): Grant` — Grant permissions to consume messages from a queue.

  This will grant the following permissions:

    - sqs:ChangeMessageVisibility
    - sqs:DeleteMessage
    - sqs:ReceiveMessage
    - sqs:GetQueueAttributes
    - sqs:GetQueueUrl

  If encryption is used, permission to use the key to decrypt the contents of the queue will also be granted to the same principal.

  This will grant the following KMS permissions:

    - kms:Decrypt

  The use of this method is discouraged. Please use `grants.consumeMessages()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — Principal to grant consume rights to.

- `grantOnKey(grantee: IGrantable, ...actions: string[]): GrantOnKeyResult` — Gives permissions to a grantable entity to perform actions on the encryption key.

- `grantPurge(grantee: IGrantable): Grant` — Grant an IAM principal permissions to purge all messages from the queue.

  This will grant the following permissions:

   - sqs:PurgeQueue
   - sqs:GetQueueAttributes
   - sqs:GetQueueUrl

  The use of this method is discouraged. Please use `grants.purge()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — Principal to grant send rights to.

- `grantSendMessages(grantee: IGrantable): Grant` — Grant access to send messages to a queue to the given identity.

  This will grant the following permissions:

   - sqs:SendMessage
   - sqs:GetQueueAttributes
   - sqs:GetQueueUrl

  If encryption is used, permission to use the key to encrypt/decrypt the contents of the queue will also be granted to the same principal.

  This will grant the following KMS permissions:

   - kms:Decrypt
   - kms:Encrypt
   - kms:ReEncrypt*
   - kms:GenerateDataKey*

  The use of this method is discouraged. Please use `grants.sendMessages()` instead.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — Principal to grant send rights to.

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

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this Queue.

- `metricApproximateAgeOfOldestMessage(props?: MetricOptions): Metric` — The approximate age of the oldest non-deleted message in the queue.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesDelayed(props?: MetricOptions): Metric` — The number of messages in the queue that are delayed and not available for reading immediately.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesNotVisible(props?: MetricOptions): Metric` — The number of messages that are in flight.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesOutstanding(props?: MetricOptions): MathExpression` — The number of messages waiting to be picked up plus the number in flight.

  `ApproximateNumberOfMessagesVisible + ApproximateNumberOfMessagesNotVisible`, as a metric math
  expression. Prefer this over `metricApproximateNumberOfMessagesVisible` when scaling consumers
  in: receiving a message lowers `Visible`, so a policy watching only `Visible` cannot tell a
  consumer that just picked up work from one that finished it.

  `statistic`, `unit` and dimensions apply to both underlying metrics, `label`, `color` and
  `period` to the expression.

  Maximum over 5 minutes

- `metricApproximateNumberOfMessagesVisible(props?: MetricOptions): Metric` — The number of messages available for retrieval from the queue.

  Maximum over 5 minutes

- `metricNumberOfEmptyReceives(props?: MetricOptions): Metric` — The number of ReceiveMessage API calls that did not return a message.

  Sum over 5 minutes

- `metricNumberOfMessagesDeleted(props?: MetricOptions): Metric` — The number of messages deleted from the queue.

  Sum over 5 minutes

- `metricNumberOfMessagesReceived(props?: MetricOptions): Metric` — The number of messages returned by calls to the ReceiveMessage action.

  Sum over 5 minutes

- `metricNumberOfMessagesSent(props?: MetricOptions): Metric` — The number of messages added to a queue.

  Sum over 5 minutes

- `metricSentMessageSize(props?: MetricOptions): Metric` — The size of messages added to a queue.

  Average over 5 minutes

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