ReceiptRuleSet

class aws_cdk.aws_ses.ReceiptRuleSet(scope, id, *, drop_spam=None, receipt_rule_set_name=None, rules=None)

Bases: aws_cdk.core.Resource

A new receipt rule set.

stability :stability: experimental

__init__(scope, id, *, drop_spam=None, receipt_rule_set_name=None, rules=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • 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[List[ReceiptRuleOptions]]) – 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.

stability :stability: experimental

Return type

None

Methods

add_rule(id, *, actions=None, after=None, enabled=None, receipt_rule_name=None, recipients=None, scan_enabled=None, tls_policy=None)

Adds a new receipt rule in this rule set.

The new rule is added after the last added rule unless after is specified.

Parameters
  • id (str) –

  • options

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

stability :stability: experimental

Return type

ReceiptRule

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

receipt_rule_set_name

The receipt rule set name.

stability :stability: experimental

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_receipt_rule_set_name(scope, id, receipt_rule_set_name)

Import an exported receipt rule set.

Parameters
  • scope (Construct) –

  • id (str) –

  • receipt_rule_set_name (str) –

stability :stability: experimental

Return type

IReceiptRuleSet

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool