CfnReceiptRuleProps

class aws_cdk.aws_ses.CfnReceiptRuleProps(*, rule, rule_set_name, after=None)

Bases: object

Properties for defining a CfnReceiptRule.

Parameters
  • rule (Union[IResolvable, RuleProperty]) – A data structure that contains the specified rule’s name, actions, recipients, domains, enabled status, scan status, and TLS policy.

  • rule_set_name (str) – The name of the rule set where the receipt rule is added.

  • after (Optional[str]) – The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html

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

cfn_receipt_rule_props = ses.CfnReceiptRuleProps(
    rule=ses.CfnReceiptRule.RuleProperty(
        actions=[ses.CfnReceiptRule.ActionProperty(
            add_header_action=ses.CfnReceiptRule.AddHeaderActionProperty(
                header_name="headerName",
                header_value="headerValue"
            ),
            bounce_action=ses.CfnReceiptRule.BounceActionProperty(
                message="message",
                sender="sender",
                smtp_reply_code="smtpReplyCode",

                # the properties below are optional
                status_code="statusCode",
                topic_arn="topicArn"
            ),
            lambda_action=ses.CfnReceiptRule.LambdaActionProperty(
                function_arn="functionArn",

                # the properties below are optional
                invocation_type="invocationType",
                topic_arn="topicArn"
            ),
            s3_action=ses.CfnReceiptRule.S3ActionProperty(
                bucket_name="bucketName",

                # the properties below are optional
                kms_key_arn="kmsKeyArn",
                object_key_prefix="objectKeyPrefix",
                topic_arn="topicArn"
            ),
            sns_action=ses.CfnReceiptRule.SNSActionProperty(
                encoding="encoding",
                topic_arn="topicArn"
            ),
            stop_action=ses.CfnReceiptRule.StopActionProperty(
                scope="scope",

                # the properties below are optional
                topic_arn="topicArn"
            ),
            workmail_action=ses.CfnReceiptRule.WorkmailActionProperty(
                organization_arn="organizationArn",

                # the properties below are optional
                topic_arn="topicArn"
            )
        )],
        enabled=False,
        name="name",
        recipients=["recipients"],
        scan_enabled=False,
        tls_policy="tlsPolicy"
    ),
    rule_set_name="ruleSetName",

    # the properties below are optional
    after="after"
)

Attributes

after

The name of an existing rule after which the new rule is placed.

If this parameter is null, the new rule is inserted at the beginning of the rule list.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-after

Return type

Optional[str]

rule

A data structure that contains the specified rule’s name, actions, recipients, domains, enabled status, scan status, and TLS policy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rule

Return type

Union[IResolvable, RuleProperty]

rule_set_name

The name of the rule set where the receipt rule is added.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rulesetname

Return type

str