interface EmailSubscriptionProps

Language	Type name
.NET	Amazon.CDK.AWS.SNS.Subscriptions.EmailSubscriptionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssnssubscriptions#EmailSubscriptionProps
Java	software.amazon.awscdk.services.sns.subscriptions.EmailSubscriptionProps
Python	aws_cdk.aws_sns_subscriptions.EmailSubscriptionProps
TypeScript (source)	aws-cdk-lib » aws_sns_subscriptions » EmailSubscriptionProps

Options for email subscriptions.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sns as sns } from 'aws-cdk-lib';
import { aws_sns_subscriptions as sns_subscriptions } from 'aws-cdk-lib';
import { aws_sqs as sqs } from 'aws-cdk-lib';

declare const filterOrPolicy: sns.FilterOrPolicy;
declare const queue: sqs.Queue;
declare const subscriptionFilter: sns.SubscriptionFilter;
const emailSubscriptionProps: sns_subscriptions.EmailSubscriptionProps = {
  deadLetterQueue: queue,
  filterPolicy: {
    filterPolicyKey: subscriptionFilter,
  },
  filterPolicyWithMessageBody: {
    filterPolicyWithMessageBodyKey: filterOrPolicy,
  },
  json: false,
};

Properties

Name	Type	Description
deadLetterQueue?	IQueue	Queue to be used as dead letter queue.
filterPolicy?	{ [string]: SubscriptionFilter }	The filter policy.
filterPolicyWithMessageBody?	{ [string]: FilterOrPolicy }	The filter policy that is applied on the message body.
json?	boolean	Indicates if the full notification JSON should be sent to the email address or just the message text.

---

deadLetterQueue?

Type: IQueue (optional, default: No dead letter queue enabled.)

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

---

filterPolicy?

Type: { [string]: SubscriptionFilter } (optional, default: all messages are delivered)

The filter policy.

---

filterPolicyWithMessageBody?

Type: { [string]: FilterOrPolicy } (optional, default: all messages are delivered)

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.

---

json?

Type: boolean (optional, default: false (Message text))

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