Skip to content
v2.274.0

WorkMailProps Struct ​

Construction properties for a WorkMail action.

Example ​

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

declare const topic: sns.Topic;
const workMailProps: ses_actions.WorkMailProps = {
  organizationArn: 'organizationArn',

  // the properties below are optional
  topic: topic,
};

Properties ​

organizationArnstringorganization_arnstrorganizationArnStringOrganizationArnstringOrganizationArn*stringrequired#
The WorkMail organization ARN.

Amazon WorkMail organization ARNs are in the form arn:aws:workmail:region:account_ID:organization/organization_ID

example
ts
'arn:aws:workmail:us-east-1:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7'
topicoptionalITopictopicoptionalITopictopicoptionalITopicTopicoptionalITopicTopicoptionalITopic#
The SNS topic to notify when the WorkMail action is taken.

Default: no topic will be attached to the action