-
Interface Summary Interface Description BetweenCondition Between condition for a numeric attribute.CfnSubscriptionProps Properties for defining a `AWS::SNS::Subscription`.CfnTopic.SubscriptionProperty CfnTopicPolicyProps Properties for defining a `AWS::SNS::TopicPolicy`.CfnTopicProps Properties for defining a `AWS::SNS::Topic`.ITopic Represents an SNS topic.ITopic.Jsii$Default Internal default implementation forITopic.ITopicSubscription Topic subscription.ITopicSubscription.Jsii$Default Internal default implementation forITopicSubscription.NumericConditions Conditions that can be applied to numeric attributes.StringConditions Conditions that can be applied to string attributes.SubscriptionOptions Options for creating a new subscription.SubscriptionProps Properties for creating a new subscription.TopicPolicyProps Properties to associate SNS topics with a policy.TopicProps Properties for a new SNS topic.TopicSubscriptionConfig Subscription configuration. -
Enum Summary Enum Description SubscriptionProtocol The type of subscription, controlling the type of the endpoint parameter.
Package software.amazon.awscdk.services.sns Description
Amazon Simple Notification Service Construct Library
---
Add an SNS Topic to your stack:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.services.sns.*;
Topic topic = new Topic(this, "Topic", new TopicProps()
.displayName("Customer subscription topic"));
Add a FIFO SNS topic with content-based de-duplication to your stack:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.services.sns.*;
Topic topic = new Topic(this, "Topic", new TopicProps()
.contentBasedDeduplication(true)
.displayName("Customer subscription topic")
.fifo(true)
.topicName("customerTopic"));
Note that FIFO topics require a topic name to be provided. The required .fifo suffix will be automatically added to the topic name if it is not explicitly provided.
Subscriptions
Various subscriptions can be added to the topic by calling the
.addSubscription(...) method on the topic. It accepts a subscription object,
default implementations of which can be found in the
@aws-cdk/aws-sns-subscriptions package:
Add an HTTPS Subscription to your topic:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import software.amazon.awscdk.services.sns.subscriptions.*;
Object myTopic = new Topic(this, "MyTopic");
myTopic.addSubscription(new UrlSubscription("https://foobar.com/"));
Subscribe a queue to the topic:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 myTopic.addSubscription(new 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 policy
A filter policy can be specified when subscribing an endpoint to a topic.
Example with a Lambda subscription:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
Object myTopic = new Topic(this, "MyTopic");
Object fn = new Function(this, "Function", ...);
// 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 present
topic.addSubscription(LambdaSubscription.Builder.create(fn)
.filterPolicy(Map.of(
"color", sns.SubscriptionFilter.stringFilter(Map.of(
"whitelist", asList("red", "orange"),
"matchPrefixes", asList("bl"))),
"size", sns.SubscriptionFilter.stringFilter(Map.of(
"blacklist", asList("small", "medium"))),
"price", sns.SubscriptionFilter.numericFilter(Map.of(
"between", Map.of("start", 100, "stop", 200),
"greaterThan", 300)),
"store", sns.SubscriptionFilter.existsFilter()))
.build());
DLQ setup for SNS Subscription
CDK can attach provided Queue as DLQ for your SNS subscription. See the SNS DLQ configuration docs for more information about this feature.
Example of usage with user provided DLQ.
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
Object topic = new Topic(stack, "Topic");
Object dlQueue = Queue.Builder.create(stack, "DeadLetterQueue")
.queueName("MySubscription_DLQ")
.retentionPeriod(cdk.Duration.days(14))
.build();
Subscription.Builder.create(stack, "Subscription")
.endpoint("endpoint")
.protocol(sns.SubscriptionProtocol.getLAMBDA())
.topic(topic)
.deadLetterQueue(dlQueue)
.build();
CloudWatch Event Rule Target
SNS topics can be used as targets for CloudWatch event rules.
Use the @aws-cdk/aws-events-targets.SnsTopic:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 import software.amazon.awscdk.services.events.targets.*; codeCommitRepository.onCommit(new SnsTopic(myTopic));
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.