aws-cdk-lib.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
• SMS
• Amazon Data Firehose

Subscriptions to Amazon SQS, AWS Lambda and Amazon Data Firehose can be added on topics across regions.

Create an Amazon SNS Topic to add subscriptions.

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

my_topic = sns.Topic(self, "MyTopic")

Topic myTopic = new Topic(this, "MyTopic");

var myTopic = new Topic(this, "MyTopic");

myTopic := sns.NewTopic(this, jsii.String("MyTopic"))

HTTPS

Add an HTTP or HTTPS Subscription to your topic:

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

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

my_topic = sns.Topic(self, "MyTopic")

my_topic.add_subscription(subscriptions.UrlSubscription("https://foobar.com/"))

Topic myTopic = new Topic(this, "MyTopic");

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

var myTopic = new Topic(this, "MyTopic");

myTopic.AddSubscription(new UrlSubscription("https://foobar.com/"));

myTopic := sns.NewTopic(this, jsii.String("MyTopic"))

myTopic.AddSubscription(subscriptions.NewUrlSubscription(jsii.String("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.

const myTopic = new sns.Topic(this, 'MyTopic');
const url = new CfnParameter(this, 'url-param');

myTopic.addSubscription(new subscriptions.UrlSubscription(url.valueAsString));

my_topic = sns.Topic(self, "MyTopic")
url = CfnParameter(self, "url-param")

my_topic.add_subscription(subscriptions.UrlSubscription(url.value_as_string))

Topic myTopic = new Topic(this, "MyTopic");
CfnParameter url = new CfnParameter(this, "url-param");

myTopic.addSubscription(new UrlSubscription(url.getValueAsString()));

var myTopic = new Topic(this, "MyTopic");
var url = new CfnParameter(this, "url-param");

myTopic.AddSubscription(new UrlSubscription(url.ValueAsString));

myTopic := sns.NewTopic(this, jsii.String("MyTopic"))
url := awscdk.NewCfnParameter(this, jsii.String("url-param"))

myTopic.AddSubscription(subscriptions.NewUrlSubscription(url.valueAsString))

The delivery policy can also be set like so:

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

myTopic.addSubscription(
  new subscriptions.UrlSubscription(
    'https://foobar.com/',
    {
      deliveryPolicy: {
        healthyRetryPolicy: {
          minDelayTarget: Duration.seconds(5),
          maxDelayTarget: Duration.seconds(10),
          numRetries: 6,
          backoffFunction: sns.BackoffFunction.EXPONENTIAL,
        },
        throttlePolicy: {
          maxReceivesPerSecond: 10,
        },
        requestPolicy: {
          headerContentType: 'application/json',
        },
      },
    },
  ),
);

my_topic = sns.Topic(self, "MyTopic")

my_topic.add_subscription(
    subscriptions.UrlSubscription("https://foobar.com/",
        delivery_policy=sns.DeliveryPolicy(
            healthy_retry_policy=sns.HealthyRetryPolicy(
                min_delay_target=Duration.seconds(5),
                max_delay_target=Duration.seconds(10),
                num_retries=6,
                backoff_function=sns.BackoffFunction.EXPONENTIAL
            ),
            throttle_policy=sns.ThrottlePolicy(
                max_receives_per_second=10
            ),
            request_policy=sns.RequestPolicy(
                header_content_type="application/json"
            )
        )
    ))

Topic myTopic = new Topic(this, "MyTopic");

myTopic.addSubscription(
UrlSubscription.Builder.create("https://foobar.com/")
        .deliveryPolicy(DeliveryPolicy.builder()
                .healthyRetryPolicy(HealthyRetryPolicy.builder()
                        .minDelayTarget(Duration.seconds(5))
                        .maxDelayTarget(Duration.seconds(10))
                        .numRetries(6)
                        .backoffFunction(BackoffFunction.EXPONENTIAL)
                        .build())
                .throttlePolicy(ThrottlePolicy.builder()
                        .maxReceivesPerSecond(10)
                        .build())
                .requestPolicy(RequestPolicy.builder()
                        .headerContentType("application/json")
                        .build())
                .build())
        .build());

var myTopic = new Topic(this, "MyTopic");

myTopic.AddSubscription(
new UrlSubscription("https://foobar.com/", new UrlSubscriptionProps {
    DeliveryPolicy = new DeliveryPolicy {
        HealthyRetryPolicy = new HealthyRetryPolicy {
            MinDelayTarget = Duration.Seconds(5),
            MaxDelayTarget = Duration.Seconds(10),
            NumRetries = 6,
            BackoffFunction = BackoffFunction.EXPONENTIAL
        },
        ThrottlePolicy = new ThrottlePolicy {
            MaxReceivesPerSecond = 10
        },
        RequestPolicy = new RequestPolicy {
            HeaderContentType = "application/json"
        }
    }
}));

myTopic := sns.NewTopic(this, jsii.String("MyTopic"))

myTopic.AddSubscription(
subscriptions.NewUrlSubscription(jsii.String("https://foobar.com/"), &UrlSubscriptionProps{
	DeliveryPolicy: &DeliveryPolicy{
		HealthyRetryPolicy: &HealthyRetryPolicy{
			MinDelayTarget: awscdk.Duration_Seconds(jsii.Number(5)),
			MaxDelayTarget: awscdk.Duration_*Seconds(jsii.Number(10)),
			NumRetries: jsii.Number(6),
			BackoffFunction: sns.BackoffFunction_EXPONENTIAL,
		},
		ThrottlePolicy: &ThrottlePolicy{
			MaxReceivesPerSecond: jsii.Number(10),
		},
		RequestPolicy: &RequestPolicy{
			HeaderContentType: jsii.String("application/json"),
		},
	},
}))

Amazon SQS

Subscribe a queue to your topic:

const myQueue = new sqs.Queue(this, 'MyQueue');
const myTopic = new sns.Topic(this, 'MyTopic');

myTopic.addSubscription(new subscriptions.SqsSubscription(myQueue));

my_queue = sqs.Queue(self, "MyQueue")
my_topic = sns.Topic(self, "MyTopic")

my_topic.add_subscription(subscriptions.SqsSubscription(my_queue))

Queue myQueue = new Queue(this, "MyQueue");
Topic myTopic = new Topic(this, "MyTopic");

myTopic.addSubscription(new SqsSubscription(myQueue));

var myQueue = new Queue(this, "MyQueue");
var myTopic = new Topic(this, "MyTopic");

myTopic.AddSubscription(new SqsSubscription(myQueue));

myQueue := sqs.NewQueue(this, jsii.String("MyQueue"))
myTopic := sns.NewTopic(this, jsii.String("MyTopic"))

myTopic.AddSubscription(subscriptions.NewSqsSubscription(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:

import * as lambda from 'aws-cdk-lib/aws-lambda';

const myTopic = new sns.Topic(this, 'myTopic');
declare const myFunction: lambda.Function;
myTopic.addSubscription(new subscriptions.LambdaSubscription(myFunction));

import aws_cdk.aws_lambda as lambda_
# my_function: lambda.Function


my_topic = sns.Topic(self, "myTopic")
my_topic.add_subscription(subscriptions.LambdaSubscription(my_function))

import software.amazon.awscdk.services.lambda.*;
Function myFunction;


Topic myTopic = new Topic(this, "myTopic");
myTopic.addSubscription(new LambdaSubscription(myFunction));

using Amazon.CDK.AWS.Lambda;
Function myFunction;


var myTopic = new Topic(this, "myTopic");
myTopic.AddSubscription(new LambdaSubscription(myFunction));

import lambda "github.com/aws/aws-cdk-go/awscdk"
var myFunction Function


myTopic := sns.NewTopic(this, jsii.String("myTopic"))
myTopic.AddSubscription(subscriptions.NewLambdaSubscription(myFunction))

Email

Subscribe an email address to your topic:

const myTopic = new sns.Topic(this, 'MyTopic');
myTopic.addSubscription(new subscriptions.EmailSubscription('foo@bar.com'));

my_topic = sns.Topic(self, "MyTopic")
my_topic.add_subscription(subscriptions.EmailSubscription("foo@bar.com"))

Topic myTopic = new Topic(this, "MyTopic");
myTopic.addSubscription(new EmailSubscription("foo@bar.com"));

var myTopic = new Topic(this, "MyTopic");
myTopic.AddSubscription(new EmailSubscription("foo@bar.com"));

myTopic := sns.NewTopic(this, jsii.String("MyTopic"))
myTopic.AddSubscription(subscriptions.NewEmailSubscription(jsii.String("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.

const myTopic = new sns.Topic(this, 'Topic');
const emailAddress = new CfnParameter(this, 'email-param');

myTopic.addSubscription(new subscriptions.EmailSubscription(emailAddress.valueAsString));

my_topic = sns.Topic(self, "Topic")
email_address = CfnParameter(self, "email-param")

my_topic.add_subscription(subscriptions.EmailSubscription(email_address.value_as_string))

Topic myTopic = new Topic(this, "Topic");
CfnParameter emailAddress = new CfnParameter(this, "email-param");

myTopic.addSubscription(new EmailSubscription(emailAddress.getValueAsString()));

var myTopic = new Topic(this, "Topic");
var emailAddress = new CfnParameter(this, "email-param");

myTopic.AddSubscription(new EmailSubscription(emailAddress.ValueAsString));

myTopic := sns.NewTopic(this, jsii.String("Topic"))
emailAddress := awscdk.NewCfnParameter(this, jsii.String("email-param"))

myTopic.AddSubscription(subscriptions.NewEmailSubscription(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:

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

myTopic.addSubscription(new subscriptions.SmsSubscription('+15551231234'));

my_topic = sns.Topic(self, "Topic")

my_topic.add_subscription(subscriptions.SmsSubscription("+15551231234"))

Topic myTopic = new Topic(this, "Topic");

myTopic.addSubscription(new SmsSubscription("+15551231234"));

var myTopic = new Topic(this, "Topic");

myTopic.AddSubscription(new SmsSubscription("+15551231234"));

myTopic := sns.NewTopic(this, jsii.String("Topic"))

myTopic.AddSubscription(subscriptions.NewSmsSubscription(jsii.String("+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.

const myTopic = new sns.Topic(this, 'Topic');
const smsNumber = new CfnParameter(this, 'sms-param');

myTopic.addSubscription(new subscriptions.SmsSubscription(smsNumber.valueAsString));

my_topic = sns.Topic(self, "Topic")
sms_number = CfnParameter(self, "sms-param")

my_topic.add_subscription(subscriptions.SmsSubscription(sms_number.value_as_string))

Topic myTopic = new Topic(this, "Topic");
CfnParameter smsNumber = new CfnParameter(this, "sms-param");

myTopic.addSubscription(new SmsSubscription(smsNumber.getValueAsString()));

var myTopic = new Topic(this, "Topic");
var smsNumber = new CfnParameter(this, "sms-param");

myTopic.AddSubscription(new SmsSubscription(smsNumber.ValueAsString));

myTopic := sns.NewTopic(this, jsii.String("Topic"))
smsNumber := awscdk.NewCfnParameter(this, jsii.String("sms-param"))

myTopic.AddSubscription(subscriptions.NewSmsSubscription(smsNumber.valueAsString))

Amazon Data Firehose

Subscribe an Amazon Data Firehose delivery stream to your topic:

import * as firehose from 'aws-cdk-lib/aws-kinesisfirehose';

const myTopic = new sns.Topic(this, 'Topic');
declare const stream: firehose.DeliveryStream;

myTopic.addSubscription(new subscriptions.FirehoseSubscription(stream));

import aws_cdk.aws_kinesisfirehose as firehose
# stream: firehose.DeliveryStream


my_topic = sns.Topic(self, "Topic")

my_topic.add_subscription(subscriptions.FirehoseSubscription(stream))

import software.amazon.awscdk.services.kinesisfirehose.*;
DeliveryStream stream;


Topic myTopic = new Topic(this, "Topic");

myTopic.addSubscription(new FirehoseSubscription(stream));

using Amazon.CDK.AWS.KinesisFirehose;
DeliveryStream stream;


var myTopic = new Topic(this, "Topic");

myTopic.AddSubscription(new FirehoseSubscription(stream));

import firehose "github.com/aws/aws-cdk-go/awscdk"
var stream DeliveryStream


myTopic := sns.NewTopic(this, jsii.String("Topic"))

myTopic.AddSubscription(subscriptions.NewFirehoseSubscription(stream))

To remove any Amazon SNS metadata from published messages, specify rawMessageDelivery to true.

import * as firehose from 'aws-cdk-lib/aws-kinesisfirehose';

const myTopic = new sns.Topic(this, 'Topic');
declare const stream: firehose.DeliveryStream;

myTopic.addSubscription(new subscriptions.FirehoseSubscription(stream, {
  rawMessageDelivery: true,
}));

import aws_cdk.aws_kinesisfirehose as firehose
# stream: firehose.DeliveryStream


my_topic = sns.Topic(self, "Topic")

my_topic.add_subscription(subscriptions.FirehoseSubscription(stream,
    raw_message_delivery=True
))

import software.amazon.awscdk.services.kinesisfirehose.*;
DeliveryStream stream;


Topic myTopic = new Topic(this, "Topic");

myTopic.addSubscription(FirehoseSubscription.Builder.create(stream)
        .rawMessageDelivery(true)
        .build());

using Amazon.CDK.AWS.KinesisFirehose;
DeliveryStream stream;


var myTopic = new Topic(this, "Topic");

myTopic.AddSubscription(new FirehoseSubscription(stream, new FirehoseSubscriptionProps {
    RawMessageDelivery = true
}));

import firehose "github.com/aws/aws-cdk-go/awscdk"
var stream DeliveryStream


myTopic := sns.NewTopic(this, jsii.String("Topic"))

myTopic.AddSubscription(subscriptions.NewFirehoseSubscription(stream, &FirehoseSubscriptionProps{
	RawMessageDelivery: jsii.Boolean(true),
}))

Types

Name	Kind	Summary
EmailSubscription	Class	Use an email address as a subscription target.
EmailSubscriptionProps	Struct	Options for email subscriptions.
FirehoseSubscription	Class	Use an Amazon Data Firehose delivery stream as a subscription target.
FirehoseSubscriptionProps	Struct	Properties for an Amazon Data Firehose subscription.
LambdaSubscription	Class	Use a Lambda function as a subscription target.
LambdaSubscriptionProps	Struct	Properties for a Lambda subscription.
SmsSubscription	Class	Use an sms address as a subscription target.
SmsSubscriptionProps	Struct	Options for SMS subscriptions.
SqsSubscription	Class	Use an SQS queue as a subscription target.
SqsSubscriptionProps	Struct	Properties for an SQS subscription.
SubscriptionProps	Struct	Options to subscribing to an SNS topic.
UrlSubscription	Class	Use a URL as a subscription target.
UrlSubscriptionProps	Struct	Options for URL subscriptions.