Package software.amazon.awscdk.services.sqs
Amazon Simple Queue Service Construct Library
---
AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
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 software.amazon.awscdk.services.sqs.*;
Basic usage
Here's how to add a basic queue to your application:
new 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
// Use managed key
Queue.Builder.create(this, "Queue")
.encryption(QueueEncryption.KMS_MANAGED)
.build();
// Use custom key
Key myKey = new Key(this, "Key");
Queue.Builder.create(this, "Queue")
.encryption(QueueEncryption.KMS)
.encryptionMasterKey(myKey)
.build();
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 by enabling a FIFO specific feature such as: content-based deduplication,
deduplication scope or fifo throughput limit.
Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html
-
ClassDescriptionA CloudFormation
AWS::SQS::Queue.A fluent builder forCfnQueue.A CloudFormationAWS::SQS::QueuePolicy.A fluent builder forCfnQueuePolicy.Properties for defining aCfnQueuePolicy.A builder forCfnQueuePolicyPropsAn implementation forCfnQueuePolicyPropsProperties for defining aCfnQueue.A builder forCfnQueuePropsAn implementation forCfnQueuePropsDead letter queue settings.A builder forDeadLetterQueueAn implementation forDeadLetterQueueWhat kind of deduplication scope to apply.Whether the FIFO queue throughput quota applies to the entire queue or per message group.Represents an SQS queue.Internal default implementation forIQueue.A proxy class which represents a concrete javascript instance of this type.A new Amazon SQS queue.A fluent builder forQueue.Reference to a queue.A builder forQueueAttributesAn implementation forQueueAttributesReference to a new or existing Amazon SQS queue.What kind of encryption to apply to this queue.The policy for an SQS Queue.A fluent builder forQueuePolicy.Properties to associate SQS queues with a policy.A builder forQueuePolicyPropsAn implementation forQueuePolicyPropsProperties for creating a new Queue.A builder forQueuePropsAn implementation forQueueProps