# @aws-cdk/aws-sns > The CDK Construct Library for AWS::SNS Latest version **1.204.0** (published 2023-06-19) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install @aws-cdk/aws-sns pnpm add @aws-cdk/aws-sns yarn add @aws-cdk/aws-sns bun add @aws-cdk/aws-sns ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.204.0 | | Published | 2023-06-19 | | First published | 2018-07-31 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | >= 14.15.0 | | Dependencies | 8 | | Unpacked size | 577.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 12922 | | Author | Amazon Web Services | | Maintainers | romainmuller, amzn-oss, rix0rrr, aws-cdk-team | | Keywords | aws, cdk, constructs, sns | ## Links - npm: https://www.npmjs.com/package/@aws-cdk/aws-sns - Repository: https://github.com/aws/aws-cdk - Issues: https://github.com/aws/aws-cdk/issues - npm.io page: https://npm.io/package/@aws-cdk/aws-sns ## Dependencies (8) - [constructs](https://npm.io/package/constructs.md) ^3.3.69 - [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) 1.204.0 - [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) 1.204.0 - [@aws-cdk/aws-kms](https://npm.io/package/@aws-cdk/aws-kms.md) 1.204.0 - [@aws-cdk/aws-sqs](https://npm.io/package/@aws-cdk/aws-sqs.md) 1.204.0 - [@aws-cdk/aws-events](https://npm.io/package/@aws-cdk/aws-events.md) 1.204.0 - [@aws-cdk/aws-cloudwatch](https://npm.io/package/@aws-cdk/aws-cloudwatch.md) 1.204.0 - [@aws-cdk/aws-codestarnotifications](https://npm.io/package/@aws-cdk/aws-codestarnotifications.md) 1.204.0 ## Alternatives - [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads - [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads - [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads - [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads - [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads ## Recent versions - 1.204.0 (latest) — 2023-06-19 - 1.203.0 — 2023-05-31 - 1.202.0 — 2023-05-22 - 1.201.0 — 2023-05-10 - 1.200.0 — 2023-04-26 - 1.199.0 — 2023-04-20 - 1.198.1 — 2023-03-31 - 1.198.0 — 2023-03-22 - 1.197.0 — 2023-03-14 - 1.196.0 — 2023-03-08 - 1.195.0 — 2023-03-02 - 1.194.0 — 2023-02-21 - 1.193.0 — 2023-02-15 - 1.192.0 — 2023-02-09 - 1.191.0 — 2023-01-31 - … 273 more at https://npm.io/package/@aws-cdk/aws-sns/versions ## README # Amazon Simple Notification Service Construct Library --- ![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge) > 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][doc]. > > [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html --- Add an SNS Topic to your stack: ```ts const topic = new sns.Topic(this, 'Topic', { displayName: 'Customer subscription topic', }); ``` Add a FIFO SNS topic with content-based de-duplication to your stack: ```ts const topic = new sns.Topic(this, 'Topic', { contentBasedDeduplication: true, displayName: 'Customer subscription topic', fifo: true, topicName: 'customerTopic', }); ``` Note that FIFO topics require a topic name to be provided. The required `.fifo` suffix will be automatically added to the topic name if it is not explicitly provided. ## Subscriptions Various subscriptions can be added to the topic by calling the `.addSubscription(...)` method on the topic. It accepts a *subscription* object, default implementations of which can be found in the `@aws-cdk/aws-sns-subscriptions` package: Add an HTTPS Subscription to your topic: ```ts const myTopic = new sns.Topic(this, 'MyTopic'); myTopic.addSubscription(new subscriptions.UrlSubscription('https://foobar.com/')); ``` Subscribe a queue to the topic: ```ts declare const queue: sqs.Queue; const myTopic = new sns.Topic(this, 'MyTopic'); myTopic.addSubscription(new subscriptions.SqsSubscription(queue)); ``` Note that subscriptions of queues in different accounts need to be manually confirmed by reading the initial message from the queue and visiting the link found in it. ### Filter policy A filter policy can be specified when subscribing an endpoint to a topic. Example with a Lambda subscription: ```ts import * as lambda from '@aws-cdk/aws-lambda'; const myTopic = new sns.Topic(this, 'MyTopic'); declare const fn: lambda.Function; // Lambda should receive only message matching the following conditions on attributes: // color: 'red' or 'orange' or begins with 'bl' // size: anything but 'small' or 'medium' // price: between 100 and 200 or greater than 300 // store: attribute must be present myTopic.addSubscription(new subscriptions.LambdaSubscription(fn, { filterPolicy: { color: sns.SubscriptionFilter.stringFilter({ allowlist: ['red', 'orange'], matchPrefixes: ['bl'], }), size: sns.SubscriptionFilter.stringFilter({ denylist: ['small', 'medium'], }), price: sns.SubscriptionFilter.numericFilter({ between: { start: 100, stop: 200 }, greaterThan: 300, }), store: sns.SubscriptionFilter.existsFilter(), }, })); ``` ### Example of Firehose Subscription ```ts import { DeliveryStream } from '@aws-cdk/aws-kinesisfirehose'; const topic = new sns.Topic(this, 'Topic'); declare const stream: DeliveryStream; new sns.Subscription(this, 'Subscription', { topic, endpoint: stream.deliveryStreamArn, protocol: sns.SubscriptionProtocol.FIREHOSE, subscriptionRoleArn: "SAMPLE_ARN", //role with permissions to send messages to a firehose delivery stream }); ``` ## DLQ setup for SNS Subscription CDK can attach provided Queue as DLQ for your SNS subscription. See the [SNS DLQ configuration docs](https://docs.aws.amazon.com/sns/latest/dg/sns-configure-dead-letter-queue.html) for more information about this feature. Example of usage with user provided DLQ. ```ts const topic = new sns.Topic(this, 'Topic'); const dlQueue = new sqs.Queue(this, 'DeadLetterQueue', { queueName: 'MySubscription_DLQ', retentionPeriod: Duration.days(14), }); new sns.Subscription(this, 'Subscription', { endpoint: 'endpoint', protocol: sns.SubscriptionProtocol.LAMBDA, topic, deadLetterQueue: dlQueue, }); ``` ## CloudWatch Event Rule Target SNS topics can be used as targets for CloudWatch event rules. Use the `@aws-cdk/aws-events-targets.SnsTopic`: ```ts import * as codecommit from '@aws-cdk/aws-codecommit'; import * as targets from '@aws-cdk/aws-events-targets'; declare const repo: codecommit.Repository; const myTopic = new sns.Topic(this, 'Topic'); repo.onCommit('OnCommit', { target: new targets.SnsTopic(myTopic), }); ``` This will result in adding a target to the event rule and will also modify the topic resource policy to allow CloudWatch events to publish to the topic. ## Topic Policy A topic policy is automatically created when `addToResourcePolicy` is called, if one doesn't already exist. Using `addToResourcePolicy` is the simplest way to add policies, but a `TopicPolicy` can also be created manually. ```ts const topic = new sns.Topic(this, 'Topic'); const topicPolicy = new sns.TopicPolicy(this, 'TopicPolicy', { topics: [topic], }); topicPolicy.document.addStatements(new iam.PolicyStatement({ actions: ["sns:Subscribe"], principals: [new iam.AnyPrincipal()], resources: [topic.topicArn], })); ``` A policy document can also be passed on `TopicPolicy` construction ```ts const topic = new sns.Topic(this, 'Topic'); const policyDocument = new iam.PolicyDocument({ assignSids: true, statements: [ new iam.PolicyStatement({ actions: ["sns:Subscribe"], principals: [new iam.AnyPrincipal()], resources: [topic.topicArn], }), ], }); const topicPolicy = new sns.TopicPolicy(this, 'Policy', { topics: [topic], policyDocument, }); ``` --- _Source: https://npm.io/package/@aws-cdk/aws-sns · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._