Queue

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

contentBasedDeduplication

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

dataKeyReuse

Send messages to this queue if they were unsuccessfully dequeued a number of times.

deadLetterQueue

For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.

(Only applies to FIFO queues.)

deduplicationScope

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.

deliveryDelay

Whether the contents of the queue are encrypted, and by what type of key.

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

encryption

External KMS key to use for queue encryption.

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

encryptionMasterKey

enforceSSL

Whether this a first-in-first-out (FIFO) queue.

fifo

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

fifoThroughputLimit

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

maxMessageSizeBytes

A name for the queue.

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

queueName

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.

receiveMessageWaitTime

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.

redriveAllowPolicy

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.

removalPolicy

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

retentionPeriod

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.

visibilityTimeout

The policy for an SQS Queue.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called
`addToResourcePolicy()`, which will automatically create a new resource
policy if one doesn't exist yet, otherwise it will add to the existing
policy.

Prefer to use `addToResourcePolicy()` instead.

QueuePolicy

The set of queues this policy applies to.

queues

The `AWS::SQS::Queue` resource creates an Amazon SQS standard or FIFO queue.

Keep the following caveats in mind:

- If you don't specify the `FifoQueue` property, Amazon SQS creates a standard queue.

> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Amazon SQS Developer Guide* .
- If you don't provide a value for a property, the queue is created with the default value for the property.
- If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
- To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see [Creating an Amazon SQS queue ( CloudFormation )](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/create-queue-cloudformation.html) in the *Amazon SQS Developer Guide* .

CfnQueue

For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication.

During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the `ContentBasedDeduplication` attribute for the `[CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)` action in the *Amazon SQS API Reference* .

For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.

Valid values are `messageGroup` and `queue` .

To enable high throughput for a FIFO queue, set this attribute to `messageGroup` *and* set the `FifoThroughputLimit` attribute to `perMessageGroupId` . If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .

The time in seconds for which 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` .

delaySeconds

If set to true, creates a FIFO queue.

If you don't specify this property, Amazon SQS creates a standard queue. For more information, see [Amazon SQS FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html) in the *Amazon SQS Developer Guide* .

fifoQueue

For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.

Valid values are `perQueue` and `perMessageGroupId` .

To enable high throughput for a FIFO queue, set this attribute to `perMessageGroupId` *and* set the `DeduplicationScope` attribute to `messageGroup` . If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .

The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS  again.

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

> A shorter time period provides better security, but results in more calls to AWS  , which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Amazon SQS Developer Guide* .

kmsDataKeyReusePeriodSeconds

The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS.

To use the AWS managed KMS for Amazon SQS , specify a (default) alias ARN, alias name (for example `alias/aws/sqs` ), key ARN, or key ID. For more information, see the following:

- [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide*
- [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference*
- [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *AWS Key Management Service API Reference*
- The Key Management Service (KMS) section of the [Security best practices for AWS Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/best-practices.html) in the *AWS Key Management Service Developer Guide*

kmsMasterKeyId

The limit of how many bytes that a message can contain before Amazon SQS rejects it.

You can specify an integer from 1,024 bytes (1 KiB) to 1,048,576 bytes (1 MiB).
Default: 1,048,576 bytes (1 MiB).

maximumMessageSize

The number of seconds that Amazon SQS retains a message.

You can specify an integer value from `60` seconds (1 minute) to `1,209,600` seconds (14 days). The default value is `345,600` seconds (4 days).

messageRetentionPeriod

A name for the queue.

To create a FIFO queue, the name of your FIFO queue must end with the `.fifo` suffix. For more information, see [Amazon SQS FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html) in the *Amazon SQS Developer Guide* .

If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *CloudFormation User Guide* .

> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available.

You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Amazon SQS Developer Guide* .

receiveMessageWaitTimeSeconds

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 as a JSON object.

The parameters are as follows:

- `redrivePermission` : The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

- `allowAll` : (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
- `denyAll` : No source queues can specify this queue as the dead-letter queue.
- `byQueue` : Only queues specified by the `sourceQueueArns` parameter can specify this queue as the dead-letter queue.
- `sourceQueueArns` : The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the `redrivePermission` parameter is set to `byQueue` . You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the `redrivePermission` parameter to `allowAll` .

The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object.

The parameters are as follows:

- `deadLetterTargetArn` : The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of `maxReceiveCount` is exceeded.
- `maxReceiveCount` : The number of times a message is received by a consumer of the source queue before being moved to the dead-letter queue. When the `ReceiveCount` for a message exceeds the `maxReceiveCount` for a queue, Amazon SQS moves the message to the dead-letter-queue.

> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

*JSON*

`{ "deadLetterTargetArn" : *String* , "maxReceiveCount" : *Integer* }`

*YAML*

`deadLetterTargetArn : *String*`

`maxReceiveCount : *Integer*`

redrivePolicy

Enables server-side queue encryption using SQS owned encryption keys.

Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html) ). When `SqsManagedSseEnabled` is not defined, `SSE-SQS` encryption is enabled by default.

sqsManagedSseEnabled

The tags that you attach to this queue.

For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *CloudFormation User Guide* .

CfnQueueInlinePolicy

A policy document that contains the permissions for the specified Amazon SQS queues.

For more information about Amazon SQS policies, see [Using custom policies with the Amazon SQS access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Amazon SQS Developer Guide* .

policyDocument

The URLs of the queues to which you want to add the policy.

You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html)` resource.

queue

The `AWS::SQS::QueuePolicy` type applies a policy to Amazon SQS queues.

For an example snippet, see [Declaring an Amazon SQS policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *CloudFormation User Guide* .

CfnQueuePolicy

The URLs of the queues to which you want to add the policy.

You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html)` resource.

Amazon SQS

L2 Constructs2

Queue

QueuePolicy

L1 Constructs3

CfnQueue

CfnQueueInlinePolicy

CfnQueuePolicy

Get the Amazon SQS Cheat Sheet

Quick Facts

Related Links