EmailSubscription

class aws_cdk.aws_sns_subscriptions.EmailSubscription(email_address, *, json=None, dead_letter_queue=None, filter_policy=None, filter_policy_with_message_body=None)

Bases: object

Use an email address as a subscription target.

Email subscriptions require confirmation.

ExampleMetadata:

infused

Example:

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

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

  • email_address (str) –

  • json (Optional[bool]) – Indicates if the full notification JSON should be sent to the email address or just the message text. Default: false (Message text)

  • dead_letter_queue (Optional[IQueue]) – Queue to be used as dead letter queue. If not passed no dead letter queue is enabled. Default: - No dead letter queue enabled.

  • filter_policy (Optional[Mapping[str, SubscriptionFilter]]) – The filter policy. Default: - all messages are delivered

  • filter_policy_with_message_body (Optional[Mapping[str, FilterOrPolicy]]) – The filter policy that is applied on the message body. To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used. Default: - all messages are delivered

Methods

bind(_topic)

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

Parameters:

_topic (ITopic) –

Return type:

TopicSubscriptionConfig