UNPKG

884 BTypeScriptView Raw
1import * as sns from '@aws-cdk/aws-sns';
2import { SubscriptionProps } from './subscription';
3/**
4 * Options for email subscriptions.
5 */
6export interface EmailSubscriptionProps extends SubscriptionProps {
7 /**
8 * Indicates if the full notification JSON should be sent to the email
9 * address or just the message text.
10 *
11 * @default false (Message text)
12 */
13 readonly json?: boolean;
14}
15/**
16 * Use an email address as a subscription target
17 *
18 * Email subscriptions require confirmation.
19 */
20export declare class EmailSubscription implements sns.ITopicSubscription {
21 private readonly emailAddress;
22 private readonly props;
23 constructor(emailAddress: string, props?: EmailSubscriptionProps);
24 /**
25 * Returns a configuration for an email address to subscribe to an SNS topic
26 */
27 bind(_topic: sns.ITopic): sns.TopicSubscriptionConfig;
28}