@aws-cdk/aws-sqs
Advanced tools
@aws-cdk/aws-sqs is an AWS Cloud Development Kit (CDK) library that allows you to define Amazon Simple Queue Service (SQS) queues in your AWS infrastructure as code. It provides a high-level, object-oriented abstraction to create and manage SQS queues, configure their properties, and integrate them with other AWS services.
Create an SQS Queue
This code sample demonstrates how to create a basic SQS queue with a visibility timeout of 300 seconds using the AWS CDK.
const cdk = require('@aws-cdk/core');
const sqs = require('@aws-cdk/aws-sqs');
class MyStack extends cdk.Stack {
constructor(scope, id, props) {
super(scope, id, props);
const queue = new sqs.Queue(this, 'MyQueue', {
visibilityTimeout: cdk.Duration.seconds(300)
});
}
}
const app = new cdk.App();
new MyStack(app, 'MyStack');Configure Dead-Letter Queue
This code sample shows how to configure a dead-letter queue for an SQS queue. Messages that are not successfully processed after 5 attempts will be moved to the dead-letter queue.
const cdk = require('@aws-cdk/core');
const sqs = require('@aws-cdk/aws-sqs');
class MyStack extends cdk.Stack {
constructor(scope, id, props) {
super(scope, id, props);
const deadLetterQueue = new sqs.Queue(this, 'DeadLetterQueue');
const queue = new sqs.Queue(this, 'MyQueue', {
deadLetterQueue: {
queue: deadLetterQueue,
maxReceiveCount: 5
}
});
}
}
const app = new cdk.App();
new MyStack(app, 'MyStack');Integrate SQS with Lambda
This code sample demonstrates how to integrate an SQS queue with an AWS Lambda function. The Lambda function will be triggered whenever a new message is added to the SQS queue.
const cdk = require('@aws-cdk/core');
const sqs = require('@aws-cdk/aws-sqs');
const lambda = require('@aws-cdk/aws-lambda');
const lambdaEventSources = require('@aws-cdk/aws-lambda-event-sources');
class MyStack extends cdk.Stack {
constructor(scope, id, props) {
super(scope, id, props);
const queue = new sqs.Queue(this, 'MyQueue');
const myFunction = new lambda.Function(this, 'MyFunction', {
runtime: lambda.Runtime.NODEJS_14_X,
handler: 'index.handler',
code: lambda.Code.fromAsset('lambda')
});
myFunction.addEventSource(new lambdaEventSources.SqsEventSource(queue));
}
}
const app = new cdk.App();
new MyStack(app, 'MyStack');The aws-sdk package is the official AWS SDK for JavaScript. It provides low-level APIs for interacting with all AWS services, including SQS. Unlike @aws-cdk/aws-sqs, which is used for defining infrastructure as code, aws-sdk is used for making API calls to AWS services from your application code.
The serverless framework is a popular open-source framework for building and deploying serverless applications. It supports AWS SQS as an event source for AWS Lambda functions. While @aws-cdk/aws-sqs focuses on infrastructure as code, serverless provides a higher-level abstraction for deploying serverless applications, including SQS integration.
Pulumi is an infrastructure as code tool that supports multiple cloud providers, including AWS. It allows you to define and manage AWS SQS queues using familiar programming languages. Pulumi is similar to AWS CDK in that it provides a high-level, object-oriented abstraction for defining cloud infrastructure.
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.
Import to your project:
import sqs = require('@aws-cdk/aws-sqs');
Here's how to add a basic queue to your application:
new sqs.Queue(this, 'Queue');
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.Managed,
});
// Use custom key
const myKey = new EncryptionKey(this, 'Key');
new sqs.Queue(this, 'Queue', {
encryption: QueueEncryption.Kms,
encryptionMasterKey: myKey
});
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).
0.22.0 (2019-01-10)
This is a major release with multiple breaking changes in the core layers. Please consult the breaking changes section below for details.
We are focusing these days on finalizing the common patterns and APIs of the CDK framework and the AWS Construct Library, which is why you are seeing all these breaking changes. Expect a few more releases with changes of that nature as we stabilize these APIs, so you might want to hold off with upgrading. We will communicate when this foundational work is complete.
export() and import() to share constructs between stacks, you can stop doing that, instead of FooImportProps accept an IFoo directly on the consuming stack, and use that object as usual.ArnUtils.fromComponents() and ArnUtils.parse() have been moved onto Stack.AWS::AccountId etc) are now also accessible via Stack, as stack.accountId etc.Fn class (e.g. Fn.join(...) instead of new FnJoin(...).toString())resolve() has been moved to this.node.resolve().CloudFormationJSON.stringify() has been moved to this.node.stringifyJson(). validate() now should be protected.cloudformation.XxxResource classes have been removed. Use the CfnXxx classes instead.CfnXxx resource attributes that represented a list of strings are now typed as string[]s (via #1144). Attributes that represent strings, are still typed as string (#712) and all other attribute types are represented as cdk.Token.route53.TXTRecord class was renamed to route53.TxtRecord.zone when created (not assuming zone is the parent construct).lambda.FunctionRef to lambda.Function.XxxRef abstract classes are now IXxx interfacesXxxRefProps are now XxxImportPropsXxxRef.import(...) are now Xxx.import(...) accept XxxImportProps and return IXxxexport(): XxxImportProps is now defined in IXxx and implemented by imported resourcesFAQs
The CDK Construct Library for AWS::SQS
The npm package @aws-cdk/aws-sqs receives a total of 77,139 weekly downloads. As such, @aws-cdk/aws-sqs popularity was classified as popular.
We found that @aws-cdk/aws-sqs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.