Namespace Amazon.CDK.AWS.SNS.Subscriptions
CDK Construct Library for Amazon Simple Notification Service Subscriptions
---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.
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:
Subscriptions to Amazon SQS and AWS Lambda can be added on topics across regions.
Create an Amazon SNS Topic to add subscriptions.
var myTopic = new Topic(this, "MyTopic");
HTTPS
Add an HTTP or HTTPS Subscription to your topic:
var myTopic = new Topic(this, "MyTopic");
myTopic.AddSubscription(new UrlSubscription("https://foobar.com/"));
The URL being subscribed can also be tokens, that resolve to a URL during deployment. A typical use case is when the URL is passed in as a CloudFormation parameter. The following code defines a CloudFormation parameter and uses it in a URL subscription.
var myTopic = new Topic(this, "MyTopic");
var url = new CfnParameter(this, "url-param");
myTopic.AddSubscription(new UrlSubscription(url.ValueAsString));
Amazon SQS
Subscribe a queue to your topic:
var myQueue = new Queue(this, "MyQueue");
var myTopic = new Topic(this, "MyTopic");
myTopic.AddSubscription(new SqsSubscription(myQueue));
KMS key permissions will automatically be granted to SNS when a subscription is made to an encrypted 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:
using Amazon.CDK.AWS.Lambda;
Function myFunction;
var myTopic = new Topic(this, "myTopic");
myTopic.AddSubscription(new LambdaSubscription(myFunction));
Subscribe an email address to your topic:
var myTopic = new Topic(this, "MyTopic");
myTopic.AddSubscription(new EmailSubscription("foo@bar.com"));
The email being subscribed can also be tokens, that resolve to an email address during deployment. A typical use case is when the email address is passed in as a CloudFormation parameter. The following code defines a CloudFormation parameter and uses it in an email subscription.
var myTopic = new Topic(this, "Topic");
var emailAddress = new CfnParameter(this, "email-param");
myTopic.AddSubscription(new EmailSubscription(emailAddress.ValueAsString));
Note that email subscriptions require confirmation by visiting the link sent to the email address.
SMS
Subscribe an sms number to your topic:
var myTopic = new Topic(this, "Topic");
myTopic.AddSubscription(new SmsSubscription("+15551231234"));
The number being subscribed can also be tokens, that resolve to a number during deployment. A typical use case is when the number is passed in as a CloudFormation parameter. The following code defines a CloudFormation parameter and uses it in an sms subscription.
var myTopic = new Topic(this, "Topic");
var smsNumber = new CfnParameter(this, "sms-param");
myTopic.AddSubscription(new SmsSubscription(smsNumber.ValueAsString));
Classes
EmailSubscription | Use an email address as a subscription target. |
EmailSubscriptionProps | Options for email subscriptions. |
LambdaSubscription | Use a Lambda function as a subscription target. |
LambdaSubscriptionProps | Properties for a Lambda subscription. |
SmsSubscription | Use an sms address as a subscription target. |
SmsSubscriptionProps | Options for SMS subscriptions. |
SqsSubscription | Use an SQS queue as a subscription target. |
SqsSubscriptionProps | Properties for an SQS subscription. |
SubscriptionProps | Options to subscribing to an SNS topic. |
UrlSubscription | Use a URL as a subscription target. |
UrlSubscriptionProps | Options for URL subscriptions. |
Interfaces
IEmailSubscriptionProps | Options for email subscriptions. |
ILambdaSubscriptionProps | Properties for a Lambda subscription. |
ISmsSubscriptionProps | Options for SMS subscriptions. |
ISqsSubscriptionProps | Properties for an SQS subscription. |
ISubscriptionProps | Options to subscribing to an SNS topic. |
IUrlSubscriptionProps | Options for URL subscriptions. |