Package: aws-cdk.aws-sns
Amazon Simple Notification Service Construct Library---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.Add an SNS Topic to your stack:topic=sns.Topic(self,"Topic",display_name="Customer subscription topic")Add a FIFO SNS topic with content-based de-duplication to your stack:topic=sns.Topic(self,"Topic",content_based_deduplication=True,display_name="Customer subscription topic",fifo=True,topic_name="customerTopic")Note that FIFO topics require a topic name to be provided. The required.fifosuffix will be automatically added to the topic name if it is not explicitly provided.SubscriptionsVarious subscriptions can be added to the topic by calling the.addSubscription(...)method on the topic. It accepts asubscriptionobject,
default implementations of which can be found in the@aws-cdk/aws-sns-subscriptionspackage:Add an HTTPS Subscription to your topic:my_topic=sns.Topic(self,"MyTopic")my_topic.add_subscription(subscriptions.UrlSubscription("https://foobar.com/"))Subscribe a queue to the topic:# queue: sqs.Queuemy_topic=sns.Topic(self,"MyTopic")my_topic.add_subscription(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 policyA filter policy can be specified when subscribing an endpoint to a topic.Example with a Lambda subscription:importaws_cdk.aws_lambdaaslambda_# fn: lambda.Functionmy_topic=sns.Topic(self,"MyTopic")# 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 presentmy_topic.add_subscription(subscriptions.LambdaSubscription(fn,filter_policy={"color":sns.SubscriptionFilter.string_filter(allowlist=["red","orange"],match_prefixes=["bl"]),"size":sns.SubscriptionFilter.string_filter(denylist=["small","medium"]),"price":sns.SubscriptionFilter.numeric_filter(between=sns.BetweenCondition(start=100,stop=200),greater_than=300),"store":sns.SubscriptionFilter.exists_filter()}))Example of Firehose Subscriptionfromaws_cdk.aws_kinesisfirehoseimportDeliveryStream# stream: DeliveryStreamtopic=sns.Topic(self,"Topic")sns.Subscription(self,"Subscription",topic=topic,endpoint=stream.delivery_stream_arn,protocol=sns.SubscriptionProtocol.FIREHOSE,subscription_role_arn="SAMPLE_ARN")DLQ setup for SNS SubscriptionCDK can attach provided Queue as DLQ for your SNS subscription.
See theSNS DLQ configuration docsfor more information about this feature.Example of usage with user provided DLQ.topic=sns.Topic(self,"Topic")dl_queue=sqs.Queue(self,"DeadLetterQueue",queue_name="MySubscription_DLQ",retention_period=Duration.days(14))sns.Subscription(self,"Subscription",endpoint="endpoint",protocol=sns.SubscriptionProtocol.LAMBDA,topic=topic,dead_letter_queue=dl_queue)CloudWatch Event Rule TargetSNS topics can be used as targets for CloudWatch event rules.Use the@aws-cdk/aws-events-targets.SnsTopic:importaws_cdk.aws_codecommitascodecommitimportaws_cdk.aws_events_targetsastargets# repo: codecommit.Repositorymy_topic=sns.Topic(self,"Topic")repo.on_commit("OnCommit",target=targets.SnsTopic(my_topic))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 PolicyA topic policy is automatically created whenaddToResourcePolicyis called, if
one doesn't already exist. UsingaddToResourcePolicyis the simplest way to
add policies, but aTopicPolicycan also be created manually.topic=sns.Topic(self,"Topic")topic_policy=sns.TopicPolicy(self,"TopicPolicy",topics=[topic])topic_policy.document.add_statements(iam.PolicyStatement(actions=["sns:Subscribe"],principals=[iam.AnyPrincipal()],resources=[topic.topic_arn]))A policy document can also be passed onTopicPolicyconstructiontopic=sns.Topic(self,"Topic")policy_document=iam.PolicyDocument(assign_sids=True,statements=[iam.PolicyStatement(actions=["sns:Subscribe"],principals=[iam.AnyPrincipal()],resources=[topic.topic_arn])])topic_policy=sns.TopicPolicy(self,"Policy",topics=[topic],policy_document=policy_document)