Package software.amazon.awscdk.services.ses

Interface CfnReceiptRule.SNSActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReceiptRule.SNSActionProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

@Stability(Stable)
public static interface CfnReceiptRule.SNSActionProperty
extends software.amazon.jsii.JsiiSerializable

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS).

This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide .

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, 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.*;
 SNSActionProperty sNSActionProperty = SNSActionProperty.builder()
         .encoding("encoding")
         .topicArn("topicArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnReceiptRule.SNSActionProperty.Builder	builder()
default String	getEncoding()	The encoding to use for the email within the Amazon SNS notification.
default String	getTopicArn()	The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncoding

@Stability(Stable)
@Nullable
default String getEncoding()

The encoding to use for the email within the Amazon SNS notification.

UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-encoding

getTopicArn

@Stability(Stable)
@Nullable
default String getTopicArn()

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn

builder

@Stability(Stable)
static CfnReceiptRule.SNSActionProperty.Builder builder()

Returns:

a CfnReceiptRule.SNSActionProperty.Builder of CfnReceiptRule.SNSActionProperty