interface QueueProps

Language	Type name
.NET	`Amazon.CDK.AWS.SQS.QueueProps`
Java	`software.amazon.awscdk.services.sqs.QueueProps`
Python	`aws_cdk.aws_sqs.QueueProps`
TypeScript (source)	`@aws-cdk/aws-sqs` » `QueueProps`

Properties for creating a new Queue.

Example

// Use managed key
new sqs.Queue(this, 'Queue', {
  encryption: sqs.QueueEncryption.KMS_MANAGED,
});

// Use custom key
const myKey = new kms.Key(this, 'Key');

new sqs.Queue(this, 'Queue', {
  encryption: sqs.QueueEncryption.KMS,
  encryptionMasterKey: myKey,
});

Properties

Name	Type	Description
contentBasedDeduplication?	`boolean`	Specifies whether to enable content-based deduplication.
dataKeyReuse?	`Duration`	The length of time that Amazon SQS reuses a data key before calling KMS again.
deadLetterQueue?	`DeadLetterQueue`	Send messages to this queue if they were unsuccessfully dequeued a number of times.
deduplicationScope?	`DeduplicationScope`	For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.
deliveryDelay?	`Duration`	The time in seconds that the delivery of all messages in the queue is delayed.
encryption?	`QueueEncryption`	Whether the contents of the queue are encrypted, and by what type of key.
encryptionMasterKey?	`IKey`	External KMS master key to use for queue encryption.
fifo?	`boolean`	Whether this a first-in-first-out (FIFO) queue.
fifoThroughputLimit?	`FifoThroughputLimit`	For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.
maxMessageSizeBytes?	`number`	The limit of how many bytes that a message can contain before Amazon SQS rejects it.
queueName?	`string`	A name for the queue.
receiveMessageWaitTime?	`Duration`	Default wait time for ReceiveMessage calls.
removalPolicy?	`RemovalPolicy`	Policy to apply when the queue is removed from the stack.
retentionPeriod?	`Duration`	The number of seconds that Amazon SQS retains a message.
visibilityTimeout?	`Duration`	Timeout of processing a single message.

contentBasedDeduplication?

Type: boolean (optional, default: 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?

Type: Duration (optional, default: 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?

Type: DeadLetterQueue (optional, default: no dead-letter queue)

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

deduplicationScope?

Type: DeduplicationScope (optional, default: 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?

Type: Duration (optional, default: 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?

Type: QueueEncryption (optional, default: Unencrypted)

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.

encryptionMasterKey?

Type: IKey (optional, default: If encryption is set to KMS and not specified, a key will be created.)

External KMS master 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".

fifo?

Type: boolean (optional, default: false, unless queueName ends in '.fifo' or 'contentBasedDeduplication' is true.)

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

fifoThroughputLimit?

Type: FifoThroughputLimit (optional, default: 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?

Type: number (optional, default: 256KiB)

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 262144 bytes (256 KiB). The default value is 262144 (256 KiB).

queueName?

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

A name for the queue.

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

receiveMessageWaitTime?

Type: Duration (optional, default: 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.

removalPolicy?

Type: RemovalPolicy (optional, default: 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?

Type: Duration (optional, default: 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?

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