software.amazon.awscdk.services.ses

Interface CfnReceiptRule.WorkmailActionProperty

All Known Implementing Classes:

CfnReceiptRule.WorkmailActionProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

public static interface 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).

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ses.*;
 WorkmailActionProperty workmailActionProperty = WorkmailActionProperty.builder()
         .organizationArn("organizationArn")
         // the properties below are optional
         .topicArn("topicArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnReceiptRule.WorkmailActionProperty.Builder A builder for CfnReceiptRule.WorkmailActionProperty
static class	CfnReceiptRule.WorkmailActionProperty.Jsii$Proxy An implementation for CfnReceiptRule.WorkmailActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnReceiptRule.WorkmailActionProperty.Builder	builder()
java.lang.String	getOrganizationArn() The Amazon Resource Name (ARN) of the Amazon WorkMail organization.
default java.lang.String	getTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.

Method Detail

getOrganizationArn

java.lang.String getOrganizationArn()

The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:.

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 .

getTopicArn

default java.lang.String getTopicArn()

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.

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 .

builder

static CfnReceiptRule.WorkmailActionProperty.Builder builder()

Returns:

a CfnReceiptRule.WorkmailActionProperty.Builder of CfnReceiptRule.WorkmailActionProperty