ReceiptRuleSetProps

class aws_cdk.aws_ses.ReceiptRuleSetProps(*, drop_spam=None, receipt_rule_set_name=None, rules=None)

Bases: object

Construction properties for a ReceiptRuleSet.

Parameters:
  • drop_spam (Optional[bool]) – Whether to add a first rule to stop processing messages that have at least one spam indicator. Default: false

  • receipt_rule_set_name (Optional[str]) – The name for the receipt rule set. Default: - A CloudFormation generated name.

  • rules (Optional[Sequence[Union[ReceiptRuleOptions, Dict[str, Any]]]]) – The list of rules to add to this rule set. Rules are added in the same order as they appear in the list. Default: - No rules are added to the rule set.

ExampleMetadata:

infused

Example:

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
)

Attributes

drop_spam

Whether to add a first rule to stop processing messages that have at least one spam indicator.

Default:

false

receipt_rule_set_name

The name for the receipt rule set.

Default:
  • A CloudFormation generated name.

rules

The list of rules to add to this rule set.

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

Default:
  • No rules are added to the rule set.