software.amazon.awscdk.services.ses

Interface ReceiptRuleActionConfig

All Known Implementing Classes:

ReceiptRuleActionConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:30.350Z")
public interface ReceiptRuleActionConfig

Properties for a receipt rule action.

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.*;
 ReceiptRuleActionConfig receiptRuleActionConfig = ReceiptRuleActionConfig.builder()
         .addHeaderAction(AddHeaderActionConfig.builder()
                 .headerName("headerName")
                 .headerValue("headerValue")
                 .build())
         .bounceAction(BounceActionConfig.builder()
                 .message("message")
                 .sender("sender")
                 .smtpReplyCode("smtpReplyCode")
                 // the properties below are optional
                 .statusCode("statusCode")
                 .topicArn("topicArn")
                 .build())
         .lambdaAction(LambdaActionConfig.builder()
                 .functionArn("functionArn")
                 // the properties below are optional
                 .invocationType("invocationType")
                 .topicArn("topicArn")
                 .build())
         .s3Action(S3ActionConfig.builder()
                 .bucketName("bucketName")
                 // the properties below are optional
                 .kmsKeyArn("kmsKeyArn")
                 .objectKeyPrefix("objectKeyPrefix")
                 .topicArn("topicArn")
                 .build())
         .snsAction(SNSActionConfig.builder()
                 .encoding("encoding")
                 .topicArn("topicArn")
                 .build())
         .stopAction(StopActionConfig.builder()
                 .scope("scope")
                 // the properties below are optional
                 .topicArn("topicArn")
                 .build())
         .workmailAction(WorkmailActionConfig.builder()
                 .organizationArn("organizationArn")
                 // the properties below are optional
                 .topicArn("topicArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ReceiptRuleActionConfig.Builder	builder()
default AddHeaderActionConfig	getAddHeaderAction() Adds a header to the received email.
default BounceActionConfig	getBounceAction() Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.
default LambdaActionConfig	getLambdaAction() Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
default S3ActionConfig	getS3Action() Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.
default SNSActionConfig	getSnsAction() Publishes the email content within a notification to Amazon SNS.
default StopActionConfig	getStopAction() Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
default WorkmailActionConfig	getWorkmailAction() Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

Method Detail

getAddHeaderAction

default AddHeaderActionConfig getAddHeaderAction()

Adds a header to the received email.

getBounceAction

default BounceActionConfig getBounceAction()

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

getLambdaAction

default LambdaActionConfig getLambdaAction()

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

getS3Action

default S3ActionConfig getS3Action()

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

getSnsAction

default SNSActionConfig getSnsAction()

Publishes the email content within a notification to Amazon SNS.

getStopAction

default StopActionConfig getStopAction()

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

getWorkmailAction

default WorkmailActionConfig getWorkmailAction()

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

builder

static ReceiptRuleActionConfig.Builder builder()

Returns:

a ReceiptRuleActionConfig.Builder of ReceiptRuleActionConfig