Package software.amazon.awscdk.services.ses

Interface CfnMailManagerRuleSet.SnsActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMailManagerRuleSet.SnsActionProperty.Jsii$Proxy

Enclosing class:

CfnMailManagerRuleSet

@Stability(Stable)
public static interface CfnMailManagerRuleSet.SnsActionProperty
extends software.amazon.jsii.JsiiSerializable

The action to publish the email content to an Amazon SNS topic.

When executed, this action will send the email as a notification to the specified SNS topic.

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()
         .roleArn("roleArn")
         .topicArn("topicArn")
         // the properties below are optional
         .actionFailurePolicy("actionFailurePolicy")
         .encoding("encoding")
         .payloadType("payloadType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMailManagerRuleSet.SnsActionProperty.Builder	builder()
default String	getActionFailurePolicy()	A policy that states what to do in the case of failure.
default String	getEncoding()	The encoding to use for the email within the Amazon SNS notification.
default String	getPayloadType()	The expected payload type within the Amazon SNS notification.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS.
String	getTopicArn()	The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS.

This role must have access to the sns:Publish API for the given topic.

See Also:

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

getTopicArn

@Stability(Stable)
@NotNull
String getTopicArn()

The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.

See Also:

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

getActionFailurePolicy

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

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the sns:Publish API.

See Also:

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

getEncoding

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

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

The default value is UTF-8 . Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.

See Also:

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

getPayloadType

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

The expected payload type within the Amazon SNS notification.

CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT .

See Also:

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

builder

@Stability(Stable)
static CfnMailManagerRuleSet.SnsActionProperty.Builder builder()

Returns:

a CfnMailManagerRuleSet.SnsActionProperty.Builder of CfnMailManagerRuleSet.SnsActionProperty