Class ReceiptRuleActionConfig

Properties for a receipt rule action.

Inheritance

object

ReceiptRuleActionConfig

Implements

IReceiptRuleActionConfig

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 ReceiptRuleActionConfig : IReceiptRuleActionConfig

Syntax (vb)

Public Class ReceiptRuleActionConfig Implements IReceiptRuleActionConfig

Remarks

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 receiptRuleActionConfig = new ReceiptRuleActionConfig {
                AddHeaderAction = new AddHeaderActionConfig {
                    HeaderName = "headerName",
                    HeaderValue = "headerValue"
                },
                BounceAction = new BounceActionConfig {
                    Message = "message",
                    Sender = "sender",
                    SmtpReplyCode = "smtpReplyCode",

                    // the properties below are optional
                    StatusCode = "statusCode",
                    TopicArn = "topicArn"
                },
                LambdaAction = new LambdaActionConfig {
                    FunctionArn = "functionArn",

                    // the properties below are optional
                    InvocationType = "invocationType",
                    TopicArn = "topicArn"
                },
                S3Action = new S3ActionConfig {
                    BucketName = "bucketName",

                    // the properties below are optional
                    KmsKeyArn = "kmsKeyArn",
                    ObjectKeyPrefix = "objectKeyPrefix",
                    TopicArn = "topicArn"
                },
                SnsAction = new SNSActionConfig {
                    Encoding = "encoding",
                    TopicArn = "topicArn"
                },
                StopAction = new StopActionConfig {
                    Scope = "scope",

                    // the properties below are optional
                    TopicArn = "topicArn"
                },
                WorkmailAction = new WorkmailActionConfig {
                    OrganizationArn = "organizationArn",

                    // the properties below are optional
                    TopicArn = "topicArn"
                }
            };

Synopsis

Constructors

ReceiptRuleActionConfig()

Properties for a receipt rule action.

Properties

AddHeaderAction	Adds a header to the received email.
BounceAction	Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.
LambdaAction	Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
S3Action	Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.
SnsAction	Publishes the email content within a notification to Amazon SNS.
StopAction	Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
WorkmailAction	Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

Constructors

ReceiptRuleActionConfig()

Properties for a receipt rule action.

public ReceiptRuleActionConfig()

Remarks

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 receiptRuleActionConfig = new ReceiptRuleActionConfig {
                AddHeaderAction = new AddHeaderActionConfig {
                    HeaderName = "headerName",
                    HeaderValue = "headerValue"
                },
                BounceAction = new BounceActionConfig {
                    Message = "message",
                    Sender = "sender",
                    SmtpReplyCode = "smtpReplyCode",

                    // the properties below are optional
                    StatusCode = "statusCode",
                    TopicArn = "topicArn"
                },
                LambdaAction = new LambdaActionConfig {
                    FunctionArn = "functionArn",

                    // the properties below are optional
                    InvocationType = "invocationType",
                    TopicArn = "topicArn"
                },
                S3Action = new S3ActionConfig {
                    BucketName = "bucketName",

                    // the properties below are optional
                    KmsKeyArn = "kmsKeyArn",
                    ObjectKeyPrefix = "objectKeyPrefix",
                    TopicArn = "topicArn"
                },
                SnsAction = new SNSActionConfig {
                    Encoding = "encoding",
                    TopicArn = "topicArn"
                },
                StopAction = new StopActionConfig {
                    Scope = "scope",

                    // the properties below are optional
                    TopicArn = "topicArn"
                },
                WorkmailAction = new WorkmailActionConfig {
                    OrganizationArn = "organizationArn",

                    // the properties below are optional
                    TopicArn = "topicArn"
                }
            };

Properties

AddHeaderAction

Adds a header to the received email.

public IAddHeaderActionConfig? AddHeaderAction { get; set; }

Property Value

IAddHeaderActionConfig

Remarks

ExampleMetadata: fixture=_generated

BounceAction

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.

public IBounceActionConfig? BounceAction { get; set; }

Property Value

IBounceActionConfig

Remarks

ExampleMetadata: fixture=_generated

LambdaAction

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

public ILambdaActionConfig? LambdaAction { get; set; }

Property Value

ILambdaActionConfig

Remarks

ExampleMetadata: fixture=_generated

S3Action

Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.

public IS3ActionConfig? S3Action { get; set; }

Property Value

IS3ActionConfig

Remarks

ExampleMetadata: fixture=_generated

SnsAction

Publishes the email content within a notification to Amazon SNS.

public ISNSActionConfig? SnsAction { get; set; }

Property Value

ISNSActionConfig

Remarks

ExampleMetadata: fixture=_generated

StopAction

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

public IStopActionConfig? StopAction { get; set; }

Property Value

IStopActionConfig

Remarks

ExampleMetadata: fixture=_generated

WorkmailAction

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

public IWorkmailActionConfig? WorkmailAction { get; set; }

Property Value

IWorkmailActionConfig

Remarks

ExampleMetadata: fixture=_generated

Implements

IReceiptRuleActionConfig