@aws-cdk/aws-sqs

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

Changelog

1.88.0 (2021-02-03)

⚠ BREAKING CHANGES TO EXPERIMENTAL FEATURES

• appmesh: the properties virtualRouter and virtualNode of VirtualServiceProps have been replaced with the union-like class VirtualServiceProvider
• appmesh: the method addVirtualService has been removed from IMesh
• cloudfront: experimental EdgeFunction stack names have changed from 'edge-lambda-stack-${region}' to 'edge-lambda-stack-${stackid}' to support multiple independent CloudFront distributions with EdgeFunctions.

Features

• apigateway: cognito user pool authorizer (#12786) (ff1e5b3), closes #5618
• apigateway: import an existing Resource (#12785) (8a1a9b8), closes #4432
• appmesh: change VirtualService provider to a union-like class (#11978) (dfc765a), closes #9490
• aws-route53: cross account DNS delegations (#12680) (126a693), closes #8776
• cloudfront: add PublicKey and KeyGroup L2 constructs (#12743) (59cb6d0)
• core: stack.exportValue() can be used to solve "deadly embrace" (#12778) (3b66088), closes #7602 #2036
• ecr: Public Gallery authorization token (#12775) (8434294)
• ecs-patterns: Add PlatformVersion option to ScheduledFargateTask props (#12676) (3cbf38b), closes #12623
• elbv2: support for 2020 SSL policy (#12710) (1dd3d05), closes #12595
• iam: Permissions Boundaries (#12777) (415eb86), closes aws/aws-cdk-rfcs#5 #3242
• lambda: inline code for Python 3.8 (#12788) (8d3aaba), closes #6503

Bug Fixes

• apigateway: stack update fails to replace api key (#12745) (ffe7e42), closes #12698
• cfn-include: AWS::CloudFormation resources fail in monocdk (#12758) (5060782), closes #11595
• cli, codepipeline: renamed bootstrap stack still not supported (#12771) (40b32bb), closes #12594 #12732
• cloudfront: use node addr for edgeStackId name (#12702) (c429bb7), closes #12323
• codedeploy: wrong syntax on Windows 'installAgent' flag (#12736) (238742e), closes #12734
• codepipeline: permission denied for Action-level environment variables (#12761) (99fd074), closes #12742
• ec2: ARM-backed bastion hosts try to run x86-based Amazon Linux AMI (#12280) (1a73d76), closes #12279
• efs: EFS fails to create when using a VPC with multiple subnets per availability zone (#12097) (889d673), closes #10170
• iam: cannot use the same Role for multiple Config Rules (#12724) (2f6521a), closes #12714
• lambda: codeguru profiler not set up for Node runtime (#12712) (59db763), closes #12624