Package: aws-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 theMigrating to AWS CDK v2guide.This library provides constructs for adding subscriptions to an Amazon SNS topic.
Subscriptions can be added by calling the.addSubscription(...)method on the topic.SubscriptionsSubscriptions can be added to the following endpoints:HTTPSAmazon SQSAWS LambdaEmailSMSSubscriptions to Amazon SQS and AWS Lambda can be added on topics across regions.Create an Amazon SNS Topic to add subscriptions.my_topic=sns.Topic(self,"MyTopic")HTTPSAdd an HTTP or HTTPS Subscription to your topic:my_topic=sns.Topic(self,"MyTopic")my_topic.add_subscription(subscriptions.UrlSubscription("https://foobar.com/"))The URL being subscribed can also betokens, that resolve
to a URL during deployment. A typical use case is when the URL is passed in as aCloudFormation
parameter. The
following code defines a CloudFormation parameter and uses it in a URL subscription.my_topic=sns.Topic(self,"MyTopic")url=CfnParameter(self,"url-param")my_topic.add_subscription(subscriptions.UrlSubscription(url.value_as_string))Amazon SQSSubscribe a queue to your topic:my_queue=sqs.Queue(self,"MyQueue")my_topic=sns.Topic(self,"MyTopic")my_topic.add_subscription(subscriptions.SqsSubscription(my_queue))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 LambdaSubscribe an AWS Lambda function to your topic:importaws_cdk.aws_lambdaaslambda_# my_function: lambda.Functionmy_topic=sns.Topic(self,"myTopic")my_topic.add_subscription(subscriptions.LambdaSubscription(my_function))EmailSubscribe an email address to your topic:my_topic=sns.Topic(self,"MyTopic")my_topic.add_subscription(subscriptions.EmailSubscription("foo@bar.com"))The email being subscribed can also betokens, that resolve
to an email address during deployment. A typical use case is when the email address is passed in as aCloudFormation
parameter. The
following code defines a CloudFormation parameter and uses it in an email subscription.my_topic=sns.Topic(self,"Topic")email_address=CfnParameter(self,"email-param")my_topic.add_subscription(subscriptions.EmailSubscription(email_address.value_as_string))Note that email subscriptions require confirmation by visiting the link sent to the
email address.SMSSubscribe an sms number to your topic:my_topic=sns.Topic(self,"Topic")my_topic.add_subscription(subscriptions.SmsSubscription("+15551231234"))The number being subscribed can also betokens, that resolve
to a number during deployment. A typical use case is when the number is passed in as aCloudFormation
parameter. The
following code defines a CloudFormation parameter and uses it in an sms subscription.my_topic=sns.Topic(self,"Topic")sms_number=CfnParameter(self,"sms-param")my_topic.add_subscription(subscriptions.SmsSubscription(sms_number.value_as_string))