AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon Simple Email Service ReceiptRule WorkmailAction

The WorkmailAction property type includes an action in an Amazon SES receipt rule that calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see WorkMail Action in the Amazon Simple Email Service Developer Guide.

WorkmailAction is a property of the Amazon Simple Email Service ReceiptRule Action property type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "TopicArn" : String, "OrganizationArn" : String }

YAML

TopicArn: String OrganizationArn: String

Properties

OrganizationArn

The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see Working with Organizations in the Amazon WorkMail Administrator Guide.

Required: Yes

Type: String

Update requires: No interruption

TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic.

Required: No

Type: String

Update requires: No interruption

See Also

On this page: