Class CfnMailManagerRuleSet.SnsActionProperty

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

Inheritance

object

CfnMailManagerRuleSet.SnsActionProperty

Implements

CfnMailManagerRuleSet.ISnsActionProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnMailManagerRuleSet.SnsActionProperty : CfnMailManagerRuleSet.ISnsActionProperty

Syntax (vb)

Public Class CfnMailManagerRuleSet.SnsActionProperty Implements CfnMailManagerRuleSet.ISnsActionProperty

Remarks

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

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

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 snsActionProperty = new SnsActionProperty {
                 RoleArn = "roleArn",
                 TopicArn = "topicArn",

                 // the properties below are optional
                 ActionFailurePolicy = "actionFailurePolicy",
                 Encoding = "encoding",
                 PayloadType = "payloadType"
             };

Synopsis

Constructors

SnsActionProperty()

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

Properties

ActionFailurePolicy	A policy that states what to do in the case of failure.
Encoding	The encoding to use for the email within the Amazon SNS notification.
PayloadType	The expected payload type within the Amazon SNS notification.
RoleArn	The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS.
TopicArn	The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.

Constructors

SnsActionProperty()

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

public SnsActionProperty()

Remarks

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

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

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 snsActionProperty = new SnsActionProperty {
                 RoleArn = "roleArn",
                 TopicArn = "topicArn",

                 // the properties below are optional
                 ActionFailurePolicy = "actionFailurePolicy",
                 Encoding = "encoding",
                 PayloadType = "payloadType"
             };

Properties

ActionFailurePolicy

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

public string? ActionFailurePolicy { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-actionfailurepolicy

Encoding

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

public string? Encoding { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-encoding

PayloadType

The expected payload type within the Amazon SNS notification.

public string? PayloadType { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-payloadtype

RoleArn

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

public string RoleArn { get; set; }

Property Value

string

Remarks

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

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

TopicArn

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

public string TopicArn { get; set; }