Package software.amazon.awscdk.services.ses

Interface CfnReceiptRule.RuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReceiptRule.RuleProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

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

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

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.*;
 RuleProperty ruleProperty = RuleProperty.builder()
         .actions(List.of(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
                         .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()))
         .enabled(false)
         .name("name")
         .recipients(List.of("recipients"))
         .scanEnabled(false)
         .tlsPolicy("tlsPolicy")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnReceiptRule.RuleProperty.Builder	builder()
default Object	getActions()	An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
default Object	getEnabled()	If true , the receipt rule is active.
default String	getName()	The name of the receipt rule.
default List<String>	getRecipients()	The recipient domains and email addresses that the receipt rule applies to.
default Object	getScanEnabled()	If true , then messages that this receipt rule applies to are scanned for spam and viruses.
default String	getTlsPolicy()	Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

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

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

See Also:

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

getEnabled

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

If true , the receipt rule is active.

The default value is false .

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the receipt rule. The name must meet the following requirements:.

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
• Start and end with a letter or number.
• Contain 64 characters or fewer.

See Also:

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

getRecipients

@Stability(Stable)
@Nullable
default List<String> getRecipients()

The recipient domains and email addresses that the receipt rule applies to.

If this field is not specified, this rule matches all recipients on all verified domains.

See Also:

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

getScanEnabled

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

If true , then messages that this receipt rule applies to are scanned for spam and viruses.

The default value is false .

See Also:

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

getTlsPolicy

@Stability(Stable)
@Nullable
default String getTlsPolicy()

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

If this parameter is set to Require , Amazon SES bounces emails that are not received over TLS. The default is Optional .

Valid Values: Require | Optional

See Also:

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

builder

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

Returns:

a CfnReceiptRule.RuleProperty.Builder of CfnReceiptRule.RuleProperty