aws-solutions-constructs.aws-sns-sqs 1.141.0

CDK constructs for defining an interaction between an Amazon SNS topic and an Amazon SQS queue.

aws-sns-sqs module

---

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_sns_sqs
Typescript	@aws-solutions-constructs/aws-sns-sqs
Java	software.amazon.awsconstructs.services.snssqs

This AWS Solutions Construct implements an Amazon SNS topic connected to an Amazon SQS queue.

Here is a minimal deployable pattern definition in Typescript:

import { SnsToSqs, SnsToSqsProps } from "@aws-solutions-constructs/aws-sns-sqs";
import * as iam from '@aws-cdk/aws-iam';

const snsToSqsStack = new SnsToSqs(this, 'SnsToSqsPattern', {});

// Grant yourself permissions to use the Customer Managed KMS Key
const policyStatement = new iam.PolicyStatement({
    actions: ["kms:Encrypt", "kms:Decrypt"],
    effect: iam.Effect.ALLOW,
    principals: [ new iam.AccountRootPrincipal() ],
    resources: [ "*" ]
});

snsToSqsStack.encryptionKey?.addToResourcePolicy(policyStatement);

Initializer

new SnsToSqs(scope: Construct, id: string, props: SnsToSqsProps);

Parameters

• scope Construct
• id string
• props SnsToSqsProps

Pattern Construct Props

Name	Type	Description
existingTopicObj?	sns.Topic	An optional, existing SNS topic to be used instead of the default topic. Providing both this and topicProps will cause an error.
topicProps?	sns.TopicProps	Optional user provided properties to override the default properties for the SNS topic.
existingQueueObj?	sqs.Queue	An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.
queueProps?	sqs.QueueProps	Optional user provided properties to override the default properties for the SQS queue.
deployDeadLetterQueue?	boolean	Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.
deadLetterQueueProps?	sqs.QueueProps	Optional user-provided props to override the default props for the dead letter SQS queue.
maxReceiveCount?	number	The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.
enableEncryptionWithCustomerManagedKey?	boolean	Use a KMS Key, either managed by this CDK app, or imported. If importing an encryption key, it must be specified in the encryptionKey property for this construct.
encryptionKey?	kms.Key	An optional, imported encryption key to encrypt the SQS queue, and SNS Topic.
encryptionKeyProps?	kms.KeyProps	An optional, user provided properties to override the default properties for the KMS encryption key.

Pattern Properties

Name	Type	Description
snsTopic	sns.Topic	Returns an instance of the SNS topic created by the pattern.
encryptionKey	kms.Key	Returns an instance of kms.Key used for the SQS queue, and SNS Topic.
sqsQueue	sqs.Queue	Returns an instance of the SQS queue created by the pattern.
deadLetterQueue?	sqs.Queue	Returns an instance of the dead-letter SQS queue created by the pattern.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon SNS Topic

• Configure least privilege access permissions for SNS Topic
• Enable server-side encryption for SNS Topic using Customer managed KMS Key
• Enforce encryption of data in transit

Amazon SQS Queue

• Configure least privilege access permissions for SQS Queue
• Deploy SQS dead-letter queue for the source SQS Queue
• Enable server-side encryption for SQS Queue using Customer managed KMS Key
• Enforce encryption of data in transit

Architecture

---

© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.