aws-cdk-lib.aws_sns_subscriptions.EmailSubscription

class EmailSubscription

LanguageType name
.NETAmazon.CDK.AWS.SNS.Subscriptions.EmailSubscription
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssnssubscriptions#EmailSubscription
Javasoftware.amazon.awscdk.services.sns.subscriptions.EmailSubscription
Pythonaws_cdk.aws_sns_subscriptions.EmailSubscription
TypeScript (source)aws-cdk-lib » aws_sns_subscriptions » EmailSubscription

Implements ITopicSubscription

Use an email address as a subscription target.

Email subscriptions require confirmation.

Example

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

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

Initializer

new EmailSubscription(emailAddress: string, props?: EmailSubscriptionProps)

Parameters

  • emailAddress string
  • props EmailSubscriptionProps

Methods

NameDescription
bind(_topic)Returns a configuration for an email address to subscribe to an SNS topic.

bind(_topic)

public bind(_topic: ITopic): TopicSubscriptionConfig

Parameters

  • _topic ITopic

Returns

  • TopicSubscriptionConfig

Returns a configuration for an email address to subscribe to an SNS topic.