software.amazon.awscdk.services.ses

Interface CfnReceiptRule.ActionProperty

All Known Implementing Classes:

CfnReceiptRule.ActionProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

public static interface CfnReceiptRule.ActionProperty

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own.

An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide .

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.*;
 ActionProperty actionProperty = ActionProperty.builder()
         .addHeaderAction(AddHeaderActionProperty.builder()
                 .headerName("headerName")
                 .headerValue("headerValue")
                 .build())
         .bounceAction(BounceActionProperty.builder()
                 .message("message")
                 .sender("sender")
                 .smtpReplyCode("smtpReplyCode")
                 // the properties below are optional
                 .statusCode("statusCode")
                 .topicArn("topicArn")
                 .build())
         .lambdaAction(LambdaActionProperty.builder()
                 .functionArn("functionArn")
                 // the properties below are optional
                 .invocationType("invocationType")
                 .topicArn("topicArn")
                 .build())
         .s3Action(S3ActionProperty.builder()
                 .bucketName("bucketName")
                 // the properties below are optional
                 .kmsKeyArn("kmsKeyArn")
                 .objectKeyPrefix("objectKeyPrefix")
                 .topicArn("topicArn")
                 .build())
         .snsAction(SNSActionProperty.builder()
                 .encoding("encoding")
                 .topicArn("topicArn")
                 .build())
         .stopAction(StopActionProperty.builder()
                 .scope("scope")
                 // the properties below are optional
                 .topicArn("topicArn")
                 .build())
         .workmailAction(WorkmailActionProperty.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	CfnReceiptRule.ActionProperty.Builder A builder for CfnReceiptRule.ActionProperty
static class	CfnReceiptRule.ActionProperty.Jsii$Proxy An implementation for CfnReceiptRule.ActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnReceiptRule.ActionProperty.Builder	builder()
default java.lang.Object	getAddHeaderAction() Adds a header to the received email.
default java.lang.Object	getBounceAction() Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
default java.lang.Object	getLambdaAction() Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
default java.lang.Object	getS3Action() Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
default java.lang.Object	getSnsAction() Publishes the email content within a notification to Amazon SNS.
default java.lang.Object	getStopAction() Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
default java.lang.Object	getWorkmailAction() Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

Method Detail

getAddHeaderAction

default java.lang.Object getAddHeaderAction()

Adds a header to the received email.

getBounceAction

default java.lang.Object getBounceAction()

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

getLambdaAction

default java.lang.Object getLambdaAction()

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

getS3Action

default java.lang.Object getS3Action()

Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

getSnsAction

default java.lang.Object getSnsAction()

Publishes the email content within a notification to Amazon SNS.

getStopAction

default java.lang.Object getStopAction()

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

getWorkmailAction

default java.lang.Object getWorkmailAction()

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

builder

static CfnReceiptRule.ActionProperty.Builder builder()

Returns:

a CfnReceiptRule.ActionProperty.Builder of CfnReceiptRule.ActionProperty