@aws-cdk/aws-sns-subscriptions

CDK Construct Library for Amazon Simple Notification Service Subscriptions

---

---

This library provides constructs for adding subscriptions to an Amazon SNS topic. Subscriptions can be added by calling the .addSubscription(...) method on the topic.

Subscriptions

Subscriptions can be added to the following endpoints:

• HTTPS
• Amazon SQS
• AWS Lambda
• Email

Create an Amazon SNS Topic to add subscriptions.

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

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

HTTPS

Add an HTTPS Subscription to your topic:

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

myTopic.addSubscription(new subscriptions.UrlSubscription('https://foobar.com/'));

Amazon SQS

Subscribe a queue to your topic:

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

const myQueue = new sqs.Queue(this, 'MyQueue');

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.

AWS Lambda

Subscribe an AWS Lambda function to your topic:

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

const myFunction = new lambda.Function(this, 'Echo', {
  handler: 'index.handler',
  runtime: lambda.Runtime.NODEJS_10_X,
  code: lambda.Code.fromInline(`exports.handler = ${handler.toString()}`)
});

myTopic.addSubscription(new subscriptions.LambdaSubscription(myFunction));

Email

Subscribe an email address to your topic:

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

myTopic.addSubscription(new subscriptions.EmailSubscription('[e-mail]'));

Note that email subscriptions require confirmation by visiting the link sent to the email address.

Changelog

1.22.0 (2020-01-23)

⚠ BREAKING CHANGES TO EXPERIMENTAL FEATURES

• eks: (experimental module) the Mapping struct was renamed to AwsAuthMapping.
• core: Arn.parseArn now returns empty string for nullable Arn components. Users who were depending on an undefined value will now receive the falsy empty string.
• ecr-assets: all docker image assets are now pushed to a single ECR repository named aws-cdk/assets with an image tag based on the hash of the docker build source directory (the directory where your Dockerfile resides). See PR #5733 for details and discussion.
• autoscaling: AutoScaling by using scaleOnMetric will no longer force the alarm period to 1 minute, but use the period from the Metric object instead (5 minutes by default). Use metric.with({ period: Duration.minute(1) }) to create a high-frequency scaling policy.

Features

• apigatewayv2: fork APIGatewayV2 into its own package (#5816) (d58667e)
• cloudformation: upgrade the CloudFormation resource specification to v10.3.0 (#5882) (e5e4725)
• ecr-assets: simplify docker asset publishing (#5733) (b52b43d), closes #3463 #5807
• eks: fargate profiles (#5589) (450a127), closes #5303
• lambda: allow inline code for nodejs12.x runtime (#5710) (a1cd743)
• lambda-destinations: option to auto-extract the payload when using LambdaDestination (#5503) (321372f)
• route53-targets: Add aws-route53-targets/InterfaceVpcEndpointTarget (#4868) (6969562)
• bump JSII to version 0.21.2 (#5919) (dd18456)

Bug Fixes

• apigateway: LambdaRestApi fails when a user defined Stage is attached (#5838) (05719d7), closes #5744
• autoscaling: can't use MathExpression in scaleOnMetric (d4c1b0e), closes #5776
• SecretsManagerRDSPostgreSQLRotationMultiUser not working (49032ee)
• autoscaling: can't use block devices (fee1324), closes #5868
• core: allow empty string components in parseArn (#5875) (5ed5eb4), closes #5808
• lambda: setting log retention to INFINITE causes failure (#5876) (19ed739)
• route53: incorrect domain name produced when using HTTPS in ApplicationLoadBalancedFargateService (#5802) (5ba5a5e)