@aws-cdk/aws-sns

What is @aws-cdk/aws-sns?

@aws-cdk/aws-sns is an AWS Cloud Development Kit (CDK) library that allows you to define Amazon Simple Notification Service (SNS) topics and subscriptions in your AWS infrastructure as code. This package provides a high-level, object-oriented abstraction to create and manage SNS resources programmatically.

What are @aws-cdk/aws-sns's main functionalities?

Create an SNS Topic

This code sample demonstrates how to create an SNS topic with a display name using the AWS CDK.

const sns = require('@aws-cdk/aws-sns');
const cdk = require('@aws-cdk/core');

class MyStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    const topic = new sns.Topic(this, 'MyTopic', {
      displayName: 'My Cool Topic'
    });
  }
}

const app = new cdk.App();
new MyStack(app, 'MyStack');

Add an Email Subscription to an SNS Topic

This code sample shows how to add an email subscription to an SNS topic using the AWS CDK.

const sns = require('@aws-cdk/aws-sns');
const subs = require('@aws-cdk/aws-sns-subscriptions');
const cdk = require('@aws-cdk/core');

class MyStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    const topic = new sns.Topic(this, 'MyTopic');

    topic.addSubscription(new subs.EmailSubscription('[e-mail]'));
  }
}

const app = new cdk.App();
new MyStack(app, 'MyStack');

Add a Lambda Subscription to an SNS Topic

This code sample demonstrates how to add a Lambda function as a subscription to an SNS topic using the AWS CDK.

const sns = require('@aws-cdk/aws-sns');
const subs = require('@aws-cdk/aws-sns-subscriptions');
const lambda = require('@aws-cdk/aws-lambda');
const cdk = require('@aws-cdk/core');

class MyStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    const topic = new sns.Topic(this, 'MyTopic');

    const myFunction = new lambda.Function(this, 'MyFunction', {
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: 'index.handler',
      code: lambda.Code.fromAsset('lambda')
    });

    topic.addSubscription(new subs.LambdaSubscription(myFunction));
  }
}

const app = new cdk.App();
new MyStack(app, 'MyStack');

Other packages similar to @aws-cdk/aws-sns

aws-sdk

The aws-sdk package is the official AWS SDK for JavaScript, which provides low-level APIs for interacting with AWS services, including SNS. Unlike @aws-cdk/aws-sns, which is used for defining infrastructure as code, aws-sdk is used for making API calls to AWS services at runtime.

serverless

The serverless framework is a toolkit for deploying and operating serverless architectures, including AWS Lambda and SNS. It provides a higher-level abstraction compared to @aws-cdk/aws-sns and is focused on deploying serverless applications rather than defining infrastructure as code.

pulumi

Pulumi is an infrastructure as code tool that supports multiple cloud providers, including AWS. It allows you to define and manage cloud resources using familiar programming languages. Pulumi provides similar functionalities to @aws-cdk/aws-sns but offers a different approach and supports multiple clouds.

README

AWS SNS Construct Library

Add an SNS Topic to your stack:

import sns = require('@aws-cdk/aws-sns');

const topic = new sns.Topic(stack, 'Topic', {
    displayName: 'Customer subscription topic'
});

Subscriptions

Various subscriptions can be added to the topic by calling the .subscribeXxx() methods on the topic.

Add an HTTPS Subscription to your topic:

const myTopic = new sns.Topic(stack, 'MyTopic');

myTopic.subscribeUrl('MyHttpsSubscription', 'https://foobar.com/');

Subscribe a queue to the topic:

Example of subscribing a queue to a topic

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.

CloudWatch Event Rule Target

SNS topics can be used as targets for CloudWatch event rules:

Example of CloudWatch Event rules

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.

Changelog

0.14.0 (2018-10-26)

IMPORTANT NOTE: when upgrading to this version of the CDK framework, you must also upgrade your installation the CDK Toolkit to the matching version:

$ npm i -g aws-cdk
$ cdk --version
0.14.0 (build ...)

Bug Fixes

• remove CloudFormation property renames (#973) (3f86603), closes #852
• aws-ec2: fix retention of all egress traffic rule (#998) (b9d5b43), closes #987
• aws-s3-deployment: avoid deletion during update using physical ids (#1006) (bca99c6), closes #981 #981
• cloudformation-diff: ignore changes to DependsOn (#1005) (3605f9c), closes #274
• cloudformation-diff: track replacements (#1003) (a83ac5f), closes #1001
• docs: fix EC2 readme for "natgatway" configuration (#994) (0b1e7cc)
• docs: updates to contribution guide (#997) (b42e742)
• iam: Merge multiple principals correctly (#983) (3fc5c8c), closes #924 #916 #958

Features

• add construct library for Application AutoScaling (#933) (7861c6f), closes #856 #861 #640 #644
• add HostedZone context provider (#823) (1626c37)
• assert: haveResource lists failing properties (#1016) (7f6f3fd)
• aws-cdk: add CDK app version negotiation (#988) (db4e718), closes #891
• aws-codebuild: Introduce a CodePipeline test Action. (#873) (770f9aa)
• aws-sqs: Add grantXxx() methods (#1004) (8c90350)
• core: Pre-concatenate Fn::Join (#967) (33c32a8), closes #916 #958

BREAKING CHANGES TO EXPERIMENTAL FEATURES

• DynamoDB AutoScaling: Instead of addReadAutoScaling(), call autoScaleReadCapacity(), and similar for write scaling.
• CloudFormation resource usage: If you use L1s, you may need to change some XxxName properties back into Name. These will match the CloudFormation property names.
• You must use the matching aws-cdk toolkit when upgrading to this version, or context providers will cease to work. All existing cached context values in cdk.json will be invalidated and refreshed.