DropSpamReceiptRule

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

Bases: Construct

A rule added at the top of the rule set to drop spam/virus.

See:: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda-example-functions.html
ExampleMetadata:: fixture=_generated

Example:

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

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

drop_spam_receipt_rule = ses.DropSpamReceiptRule(self, "MyDropSpamReceiptRule",
    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
)

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

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

node: The tree node.

rule

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.