CfnReceiptRuleMixinProps

class aws_cdk.mixins_preview.aws_ses.mixins.CfnReceiptRuleMixinProps(*, after=None, rule=None, rule_set_name=None)

Bases: object

Properties for CfnReceiptRulePropsMixin.

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

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

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

See:

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.
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

cfn_receipt_rule_mixin_props = ses_mixins.CfnReceiptRuleMixinProps(
    after="after",
    rule=ses_mixins.CfnReceiptRulePropsMixin.RuleProperty(
        actions=[ses_mixins.CfnReceiptRulePropsMixin.ActionProperty(
            add_header_action=ses_mixins.CfnReceiptRulePropsMixin.AddHeaderActionProperty(
                header_name="headerName",
                header_value="headerValue"
            ),
            bounce_action=ses_mixins.CfnReceiptRulePropsMixin.BounceActionProperty(
                message="message",
                sender="sender",
                smtp_reply_code="smtpReplyCode",
                status_code="statusCode",
                topic_arn="topicArn"
            ),
            connect_action=ses_mixins.CfnReceiptRulePropsMixin.ConnectActionProperty(
                iam_role_arn="iamRoleArn",
                instance_arn="instanceArn"
            ),
            lambda_action=ses_mixins.CfnReceiptRulePropsMixin.LambdaActionProperty(
                function_arn="functionArn",
                invocation_type="invocationType",
                topic_arn="topicArn"
            ),
            s3_action=ses_mixins.CfnReceiptRulePropsMixin.S3ActionProperty(
                bucket_name="bucketName",
                iam_role_arn="iamRoleArn",
                kms_key_arn="kmsKeyArn",
                object_key_prefix="objectKeyPrefix",
                topic_arn="topicArn"
            ),
            sns_action=ses_mixins.CfnReceiptRulePropsMixin.SNSActionProperty(
                encoding="encoding",
                topic_arn="topicArn"
            ),
            stop_action=ses_mixins.CfnReceiptRulePropsMixin.StopActionProperty(
                scope="scope",
                topic_arn="topicArn"
            ),
            workmail_action=ses_mixins.CfnReceiptRulePropsMixin.WorkmailActionProperty(
                organization_arn="organizationArn",
                topic_arn="topicArn"
            )
        )],
        enabled=False,
        name="name",
        recipients=["recipients"],
        scan_enabled=False,
        tls_policy="tlsPolicy"
    ),
    rule_set_name="ruleSetName"
)

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.

See:

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

rule

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

See:

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

rule_set_name

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

See:

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