interface SnsActionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SES.CfnMailManagerRuleSet.SnsActionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsses#CfnMailManagerRuleSet_SnsActionProperty`
Java	`software.amazon.awscdk.services.ses.CfnMailManagerRuleSet.SnsActionProperty`
Python	`aws_cdk.aws_ses.CfnMailManagerRuleSet.SnsActionProperty`
TypeScript	`aws-cdk-lib` » `aws_ses` » `CfnMailManagerRuleSet` » `SnsActionProperty`

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 { aws_ses as ses } from 'aws-cdk-lib';
const snsActionProperty: ses.CfnMailManagerRuleSet.SnsActionProperty = {
  roleArn: 'roleArn',
  topicArn: 'topicArn',

  // the properties below are optional
  actionFailurePolicy: 'actionFailurePolicy',
  encoding: 'encoding',
  payloadType: 'payloadType',
};

Properties

Name	Type	Description
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS.
topicArn	`string`	The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
actionFailurePolicy?	`string`	A policy that states what to do in the case of failure.
encoding?	`string`	The encoding to use for the email within the Amazon SNS notification.
payloadType?	`string`	The expected payload type within the Amazon SNS notification.

roleArn

Type: string

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.

topicArn

Type: string

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

actionFailurePolicy?

Type: string (optional)

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.

encoding?

Type: string (optional)

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.

payloadType?

Type: string (optional)

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 .