EmailSubscriptionProps

class aws_cdk.aws_sns_subscriptions.EmailSubscriptionProps(*, dead_letter_queue=None, filter_policy=None, json=None)

Bases: SubscriptionProps

Options for email subscriptions.

Parameters:

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
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)

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sns as sns
import aws_cdk.aws_sns_subscriptions as sns_subscriptions
import aws_cdk.aws_sqs as sqs

# queue: sqs.Queue
# subscription_filter: sns.SubscriptionFilter

email_subscription_props = sns_subscriptions.EmailSubscriptionProps(
    dead_letter_queue=queue,
    filter_policy={
        "filter_policy_key": subscription_filter
    },
    json=False
)

Attributes

dead_letter_queue

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

The filter policy.

Default:

all messages are delivered

json

Indicates if the full notification JSON should be sent to the email address or just the message text.

Default:: false (Message text)