Skip to content
v2.277.0

ReceiptRuleSetProps Struct ​

Construction properties for a ReceiptRuleSet.

Example ​

ts
import * as cdk from 'aws-cdk-lib';
import * as ses from 'aws-cdk-lib/aws-ses';
import { CustomResourceConfig } from 'aws-cdk-lib/custom-resources';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack');
CustomResourceConfig.of(app).addLogRetentionLifetime(logs.RetentionDays.TEN_YEARS);
CustomResourceConfig.of(app).addRemovalPolicy(cdk.RemovalPolicy.DESTROY);

new ses.ReceiptRuleSet(app, 'RuleSet', {
  dropSpam: true,
});
python
import aws_cdk as cdk
import aws_cdk.aws_ses as ses
from aws_cdk.custom_resources import CustomResourceConfig


app = cdk.App()
stack = cdk.Stack(app, "Stack")
CustomResourceConfig.of(app).add_log_retention_lifetime(logs.RetentionDays.TEN_YEARS)
CustomResourceConfig.of(app).add_removal_policy(cdk.RemovalPolicy.DESTROY)

ses.ReceiptRuleSet(app, "RuleSet",
    drop_spam=True
)
java
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.ses.*;
import software.amazon.awscdk.customresources.CustomResourceConfig;


App app = new App();
Stack stack = new Stack(app, "Stack");
CustomResourceConfig.of(app).addLogRetentionLifetime(RetentionDays.TEN_YEARS);
CustomResourceConfig.of(app).addRemovalPolicy(RemovalPolicy.DESTROY);

ReceiptRuleSet.Builder.create(app, "RuleSet")
        .dropSpam(true)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK;
using Amazon.CDK.AWS.SES;
using Amazon.CDK.CustomResources;


var app = new App();
var stack = new Stack(app, "Stack");
CustomResourceConfig.Of(app).AddLogRetentionLifetime(RetentionDays.TEN_YEARS);
CustomResourceConfig.Of(app).AddRemovalPolicy(RemovalPolicy.DESTROY);

new ReceiptRuleSet(app, "RuleSet", new ReceiptRuleSetProps {
    DropSpam = true
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import ses "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"


app := cdk.NewApp()
stack := cdk.NewStack(app, jsii.String("Stack"))
awscdk.CustomResourceConfig_Of(app).AddLogRetentionLifetime(logs.RetentionDays_TEN_YEARS)
awscdk.CustomResourceConfig_Of(app).AddRemovalPolicy(cdk.RemovalPolicy_DESTROY)

ses.NewReceiptRuleSet(app, jsii.String("RuleSet"), &ReceiptRuleSetProps{
	DropSpam: jsii.Boolean(true),
})

Properties ​

dropSpamoptionalbooleandrop_spamoptionalbooldropSpamoptionalBooleanDropSpamoptionalboolDropSpamoptional*bool = false #
Whether to add a first rule to stop processing messages that have at least one spam indicator.
receiptRuleSetNameoptionalstringreceipt_rule_set_nameoptionalstrreceiptRuleSetNameoptionalStringReceiptRuleSetNameoptionalstringReceiptRuleSetNameoptional*string #
The name for the receipt rule set.

Default: A CloudFormation generated name.

rulesoptionalReceiptRuleOptions[]rulesoptionaltyping.List[ReceiptRuleOptions]rulesoptionalList<ReceiptRuleOptions>RulesoptionalReceiptRuleOptions[]Rulesoptional*[]ReceiptRuleOptions #
The list of rules to add to this rule set.

Default: No rules are added to the rule set.

Rules are added in the same order as they appear in the list.