Skip to content
v2.277.0

ReceiptRuleOptions Struct ​

Options to add a receipt rule to a receipt rule set.

Example ​

ts
const ruleSet = new ses.ReceiptRuleSet(this, 'RuleSet');

const awsRule = ruleSet.addRule('Aws', {
  recipients: ['aws.com'],
});
python
rule_set = ses.ReceiptRuleSet(self, "RuleSet")

aws_rule = rule_set.add_rule("Aws",
    recipients=["aws.com"]
)
java
ReceiptRuleSet ruleSet = new ReceiptRuleSet(this, "RuleSet");

ReceiptRule awsRule = ruleSet.addRule("Aws", ReceiptRuleOptions.builder()
        .recipients(List.of("aws.com"))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
var ruleSet = new ReceiptRuleSet(this, "RuleSet");

var awsRule = ruleSet.AddRule("Aws", new ReceiptRuleOptions {
    Recipients = new [] { "aws.com" }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
ruleSet := ses.NewReceiptRuleSet(this, jsii.String("RuleSet"))

awsRule := ruleSet.addRule(jsii.String("Aws"), &ReceiptRuleOptions{
	Recipients: []*string{
		jsii.String("aws.com"),
	},
})

Properties ​

actionsoptionalIReceiptRuleAction[]actionsoptionaltyping.List[IReceiptRuleAction]actionsoptionalList<IReceiptRuleAction>ActionsoptionalIReceiptRuleAction[]Actionsoptional*[]IReceiptRuleAction#
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: No actions.

afteroptionalIReceiptRuleRefafteroptionalIReceiptRuleRefafteroptionalIReceiptRuleRefAfteroptionalIReceiptRuleRefAfteroptionalIReceiptRuleRef#
An existing rule after which the new rule will be placed.

Default: The new rule is inserted at the beginning of the rule list.

enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#
Whether the rule is active.
receiptRuleNameoptionalstringreceipt_rule_nameoptionalstrreceiptRuleNameoptionalStringReceiptRuleNameoptionalstringReceiptRuleNameoptional*string#
The name for the rule.

Default: A CloudFormation generated name.

recipientsoptionalstring[]recipientsoptionaltyping.List[str]recipientsoptionalList<String>Recipientsoptionalstring[]Recipientsoptional*[]*string#
The recipient domains and email addresses that the receipt rule applies to.

Default: Match all recipients under all verified domains.

scanEnabledoptionalbooleanscan_enabledoptionalboolscanEnabledoptionalBooleanScanEnabledoptionalboolScanEnabledoptional*bool= false#
Whether to scan for spam and viruses.
tlsPolicyoptionalTlsPolicytls_policyoptionalTlsPolicytlsPolicyoptionalTlsPolicyTlsPolicyoptionalTlsPolicyTlsPolicyoptionalTlsPolicy#
Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Default: Optional which will not check for TLS.