ReceiptRuleProps

class aws_cdk.aws_ses.ReceiptRuleProps(*, actions=None, after=None, enabled=None, receipt_rule_name=None, recipients=None, scan_enabled=None, tls_policy=None, rule_set)

Bases: ReceiptRuleOptions

Construction properties for a ReceiptRule.

Parameters:

  • actions (Optional[Sequence[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.

  • after (Optional[IReceiptRule]) – An existing rule after which the new rule will be placed. Default: - The new rule is inserted at the beginning of the rule list.

  • enabled (Optional[bool]) – Whether the rule is active. Default: true

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

  • recipients (Optional[Sequence[str]]) – The recipient domains and email addresses that the receipt rule applies to. Default: - Match all recipients under all verified domains.

  • scan_enabled (Optional[bool]) – Whether to scan for spam and viruses. Default: false

  • tls_policy (Optional[TlsPolicy]) – 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.

  • rule_set (IReceiptRuleSet) – The name of the rule set that the receipt rule will be added to.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ses as ses

# receipt_rule: ses.ReceiptRule
# receipt_rule_action: ses.IReceiptRuleAction
# receipt_rule_set: ses.ReceiptRuleSet

receipt_rule_props = ses.ReceiptRuleProps(
    rule_set=receipt_rule_set,

    # the properties below are optional
    actions=[receipt_rule_action],
    after=receipt_rule,
    enabled=False,
    receipt_rule_name="receiptRuleName",
    recipients=["recipients"],
    scan_enabled=False,
    tls_policy=ses.TlsPolicy.OPTIONAL
)

Attributes

actions

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.

after

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

Default:

  • The new rule is inserted at the beginning of the rule list.

enabled

Whether the rule is active.

Default:

true

receipt_rule_name

The name for the rule.

Default:

  • A CloudFormation generated name.

recipients

The recipient domains and email addresses that the receipt rule applies to.

Default:

  • Match all recipients under all verified domains.

rule_set

The name of the rule set that the receipt rule will be added to.

scan_enabled

Whether to scan for spam and viruses.

Default:

false

tls_policy

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.