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.aws_s3 as s3
import aws_cdk.aws_ses_actions as actions


bucket = s3.Bucket(self, "Bucket")
topic = sns.Topic(self, "Topic")

ses.ReceiptRuleSet(self, "RuleSet",
    rules=[ses.ReceiptRuleOptions(
        recipients=["hello@aws.com"],
        actions=[
            actions.AddHeader(
                name="X-Special-Header",
                value="aws"
            ),
            actions.S3(
                bucket=bucket,
                object_key_prefix="emails/",
                topic=topic
            )
        ]
    ), ses.ReceiptRuleOptions(
        recipients=["aws.com"],
        actions=[
            actions.Sns(
                topic=topic
            )
        ]
    )
    ]
)

Attributes

drop_spam

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

Default

false

Return type

Optional[bool]

receipt_rule_set_name

The name for the receipt rule set.

Default
  • A CloudFormation generated name.

Return type

Optional[str]

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.

Return type

Optional[List[ReceiptRuleOptions]]