Package software.amazon.awscdk.services.ses

Interface CfnReceiptRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReceiptRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:22.952Z")
@Stability(Stable)
public interface CfnReceiptRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnReceiptRule.

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.*;
 CfnReceiptRuleProps cfnReceiptRuleProps = CfnReceiptRuleProps.builder()
         .rule(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())
                         .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()))
                 .enabled(false)
                 .name("name")
                 .recipients(List.of("recipients"))
                 .scanEnabled(false)
                 .tlsPolicy("tlsPolicy")
                 .build())
         .ruleSetName("ruleSetName")
         // the properties below are optional
         .after("after")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnReceiptRuleProps.Builder	builder()
default String	getAfter()	The name of an existing rule after which the new rule is placed.
Object	getRule()	A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
String	getRuleSetName()	The name of the rule set where the receipt rule is added.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRule

@Stability(Stable)
@NotNull
Object getRule()

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

Returns union: either IResolvable or CfnReceiptRule.RuleProperty

See Also:

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

getRuleSetName

@Stability(Stable)
@NotNull
String getRuleSetName()

The name of the rule set where the receipt rule is added.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rulesetname

getAfter

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

The name of an existing rule after which the new rule is placed.

If this parameter is null, the new rule is inserted at the beginning of the rule list.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-after

builder

@Stability(Stable)
static CfnReceiptRuleProps.Builder builder()

Returns:

a CfnReceiptRuleProps.Builder of CfnReceiptRuleProps