@aws-cdk/aws-sqs
    TypeScript icon, indicating that this package has built-in type declarations

    1.157.0 • Public • Published

    Amazon Simple Queue Service Construct Library


    cfn-resources: Stable

    cdk-constructs: Stable


    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 * as sqs from '@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: 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,
    });

    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.

    Install

    npm i @aws-cdk/aws-sqs

    DownloadsWeekly Downloads

    676,161

    Version

    1.157.0

    License

    Apache-2.0

    Unpacked Size

    459 kB

    Total Files

    25

    Last publish

    Collaborators

    • eladb
    • romainmuller
    • amzn-oss
    • rix0rrr
    • aws-cdk-team