ReceiptRule

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

Bases: Resource

A new receipt rule.

ExampleMetadata:

infused

Example:

rule_set = ses.ReceiptRuleSet(self, "RuleSet")

aws_rule = rule_set.add_rule("Aws",
    recipients=["aws.com"]
)
Parameters:

  • scope (Construct) –

  • id (str) –

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

  • 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.

Methods

add_action(action)

Adds an action to this receipt rule.

Parameters:

action (IReceiptRuleAction) –

Return type:

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The construct tree node associated with this construct.

receipt_rule_name

The name of the receipt rule.

stack

The stack in which this resource is defined.

Static Methods

classmethod from_receipt_rule_name(scope, id, receipt_rule_name)
Parameters:

  • scope (Construct) –

  • id (str) –

  • receipt_rule_name (str) –

Return type:

IReceiptRule

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool