@Stability(value=Stable)

Package software.amazon.awscdk.services.sqs

Amazon Simple Queue Service Construct Library

See: Description

Interface Summary

Interface	Description
CfnQueuePolicyProps	Properties for defining a `AWS::SQS::QueuePolicy`.
CfnQueueProps	Properties for defining a `AWS::SQS::Queue`.
DeadLetterQueue	Dead letter queue settings.
IQueue
QueueAttributes	Reference to a queue.
QueuePolicyProps
QueueProps	Properties for creating a new Queue.

Class Summary

Class	Description
CfnQueue	A CloudFormation `AWS::SQS::Queue`.
CfnQueuePolicy	A CloudFormation `AWS::SQS::QueuePolicy`.
CfnQueuePolicyProps.Builder	A builder for CfnQueuePolicyProps
CfnQueuePolicyProps.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
CfnQueueProps.Builder	A builder for CfnQueueProps
CfnQueueProps.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
DeadLetterQueue.Builder	A builder for DeadLetterQueue
DeadLetterQueue.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IQueue.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
Queue	A new Amazon SQS queue.
QueueAttributes.Builder	A builder for QueueAttributes
QueueAttributes.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
QueueBase	Reference to a new or existing Amazon SQS queue.
QueuePolicy	Applies a policy to SQS queues.
QueuePolicyProps.Builder	A builder for QueuePolicyProps
QueuePolicyProps.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
QueueProps.Builder	A builder for QueueProps
QueueProps.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Enum Summary

Enum	Description
QueueEncryption	What kind of encryption to apply to this queue.

Package software.amazon.awscdk.services.sqs Description

Amazon Simple Queue Service Construct Library

Amazon Simple Queue Service (SQS) is a fully managed message queuing service that enables you to decouple and scale microservices, distributed systems, and serverless applications. SQS eliminates the complexity and overhead associated with managing and operating message oriented middleware, and empowers developers to focus on differentiating work. Using SQS, you can send, store, and receive messages between software components at any volume, without losing messages or requiring other services to be available.

Installation

Import to your project:

import sqs = require('@aws-cdk/aws-sqs');
 

Basic usage

Here's how to add a basic queue to your application:

new sqs.Queue(this, 'Queue');
 

Encryption

If you want to encrypt the queue contents, set the encryption property. You can have the messages encrypted with a key that SQS manages for you, or a key that you can manage yourself.

// Use managed key
 new sqs.Queue(this, 'Queue', {
     encryption: QueueEncryption.KMS_MANAGED,
 });
 
 // Use custom key
 const myKey = new kms.Key(this, 'Key');
 
 new sqs.Queue(this, 'Queue', {
     encryption: QueueEncryption.KMS,
     encryptionMasterKey: myKey
 });
 

First-In-First-Out (FIFO) queues

FIFO queues give guarantees on the order in which messages are dequeued, and have additional features in order to help guarantee exactly-once processing. For more information, see the SQS manual. Note that FIFO queues are not available in all AWS regions.

A queue can be made a FIFO queue by either setting fifo: true, giving it a name which ends in ".fifo", or enabling content-based deduplication (which requires FIFO queues).