aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
38 lines (37 loc) • 1.34 kB
TypeScript
import * as ses from '../../aws-ses';
import * as sns from '../../aws-sns';
/**
* Construction properties for a WorkMail action.
*/
export interface WorkMailProps {
/**
* The WorkMail organization ARN.
*
* Amazon WorkMail organization ARNs are in the form
* `arn:aws:workmail:region:account_ID:organization/organization_ID`
*
* @example 'arn:aws:workmail:us-east-1:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7'
*/
readonly organizationArn: string;
/**
* The SNS topic to notify when the WorkMail action is taken.
*
* @default - no topic will be attached to the action
*/
readonly topic?: sns.ITopic;
}
/**
* Integrates an Amazon WorkMail action into a receipt rule set,
* and optionally publishes a notification to Amazon SNS.
*
* Beware that WorkMail should already set up an active `INBOUND_MAIL` rule set
* that includes a WorkMail rule action for this exact purpose.
* This action should be used to customize the behavior of replacement rule set.
*
* @see https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html
*/
export declare class WorkMail implements ses.IReceiptRuleAction {
private readonly props;
constructor(props: WorkMailProps);
bind(_rule: ses.IReceiptRule): ses.ReceiptRuleActionConfig;
}