Package software.amazon.awscdk.services.ses

Interface CfnReceiptRule.ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReceiptRule.ActionProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

@Stability(Stable)
public static interface CfnReceiptRule.ActionProperty
extends software.amazon.jsii.JsiiSerializable

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())
         .connectAction(ConnectActionProperty.builder()
                 .iamRoleArn("iamRoleArn")
                 .instanceArn("instanceArn")
                 .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
                 .iamRoleArn("iamRoleArn")
                 .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnReceiptRule.ActionProperty.Builder	builder()
default Object	getAddHeaderAction()	Adds a header to the received email.
default 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 Object	getConnectAction()	The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
default Object	getLambdaAction()	Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
default Object	getS3Action()	Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
default Object	getSnsAction()	Publishes the email content within a notification to Amazon SNS.
default Object	getStopAction()	Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
default Object	getWorkmailAction()	Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddHeaderAction

@Stability(Stable)
@Nullable
default Object getAddHeaderAction()

Adds a header to the received email.

Returns union: either IResolvable or CfnReceiptRule.AddHeaderActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-addheaderaction

getBounceAction

@Stability(Stable)
@Nullable
default 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).

Returns union: either IResolvable or CfnReceiptRule.BounceActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-bounceaction

getConnectAction

@Stability(Stable)
@Nullable
default Object getConnectAction()

The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.

Returns union: either IResolvable or CfnReceiptRule.ConnectActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-connectaction

getLambdaAction

@Stability(Stable)
@Nullable
default Object getLambdaAction()

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

Returns union: either IResolvable or CfnReceiptRule.LambdaActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-lambdaaction

getS3Action

@Stability(Stable)
@Nullable
default Object getS3Action()

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

Returns union: either IResolvable or CfnReceiptRule.S3ActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-s3action

getSnsAction

@Stability(Stable)
@Nullable
default Object getSnsAction()

Publishes the email content within a notification to Amazon SNS.

Returns union: either IResolvable or CfnReceiptRule.SNSActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-snsaction

getStopAction

@Stability(Stable)
@Nullable
default Object getStopAction()

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

Returns union: either IResolvable or CfnReceiptRule.StopActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-stopaction

getWorkmailAction

@Stability(Stable)
@Nullable
default Object getWorkmailAction()

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

Returns union: either IResolvable or CfnReceiptRule.WorkmailActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-workmailaction

builder

@Stability(Stable)
static CfnReceiptRule.ActionProperty.Builder builder()

Returns:

a CfnReceiptRule.ActionProperty.Builder of CfnReceiptRule.ActionProperty