Skip to content
v2.275.0

EmailSubscription Class ​

Use an email address as a subscription target.

Email subscriptions require confirmation.

Example ​

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

myTopic.addSubscription(new subscriptions.EmailSubscription(emailAddress.valueAsString));
python
my_topic = sns.Topic(self, "Topic")
email_address = CfnParameter(self, "email-param")

my_topic.add_subscription(subscriptions.EmailSubscription(email_address.value_as_string))
java
Topic myTopic = new Topic(this, "Topic");
CfnParameter emailAddress = new CfnParameter(this, "email-param");

myTopic.addSubscription(new EmailSubscription(emailAddress.getValueAsString()));
csharp
// Install: dotnet add package Amazon.CDK.Lib
var myTopic = new Topic(this, "Topic");
var emailAddress = new CfnParameter(this, "email-param");

myTopic.AddSubscription(new EmailSubscription(emailAddress.ValueAsString));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
myTopic := sns.NewTopic(this, jsii.String("Topic"))
emailAddress := awscdk.NewCfnParameter(this, jsii.String("email-param"))

myTopic.AddSubscription(subscriptions.NewEmailSubscription(emailAddress.valueAsString))

Initializer ​

ts
new EmailSubscription(emailAddress: string, props?: EmailSubscriptionProps)
python
EmailSubscription(email_address: str, props: typing.Optional[EmailSubscriptionProps] = None)
java
new EmailSubscription(String emailAddress, EmailSubscriptionProps props)
csharp
new EmailSubscription(string emailAddress, EmailSubscriptionProps? props = null)
go
NewEmailSubscription(EmailAddress *string, Props EmailSubscriptionProps)

Methods ​

bind(_topic: ITopic): TopicSubscriptionConfigdef bind(self, _topic: ITopic) -> TopicSubscriptionConfigpublic TopicSubscriptionConfig bind(ITopic _topic)public TopicSubscriptionConfig Bind(ITopic _topic)func Bind(_topic ITopic) TopicSubscriptionConfig#
Returns a configuration for an email address to subscribe to an SNS topic.