Class CfnReceiptRule.WorkmailActionProperty
When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
Inheritance
Implements
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WorkmailActionProperty : Object, CfnReceiptRule.IWorkmailActionProperty
Syntax (vb)
Public Class WorkmailActionProperty
Inherits Object
Implements CfnReceiptRule.IWorkmailActionProperty
Remarks
It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.
For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SES;
var workmailActionProperty = new WorkmailActionProperty {
OrganizationArn = "organizationArn",
// the properties below are optional
TopicArn = "topicArn"
};
Synopsis
Constructors
WorkmailActionProperty() |
Properties
OrganizationArn | The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:. |
TopicArn | The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. |
Constructors
WorkmailActionProperty()
public WorkmailActionProperty()
Properties
OrganizationArn
The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:.
public string OrganizationArn { get; set; }
Property Value
System.String
Remarks
arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with " m-
", followed by a string of alphanumeric characters.
For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .
TopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.
public string TopicArn { get; set; }
Property Value
System.String
Remarks
You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .