CfnReceiptRule

class aws_cdk.aws_ses.CfnReceiptRule(scope, id, *, after=None, rule, rule_set_name)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::SES::ReceiptRule.

CloudformationResource

AWS::SES::ReceiptRule

Link

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

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 = ses.CfnReceiptRule(self, "MyCfnReceiptRule",
    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"
)

Create a new AWS::SES::ReceiptRule.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • after (Optional[str]) – AWS::SES::ReceiptRule.After.

  • rule (Union[IResolvable, RuleProperty]) – AWS::SES::ReceiptRule.Rule.

  • rule_set_name (str) – AWS::SES::ReceiptRule.RuleSetName.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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 (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SES::ReceiptRule'
after

AWS::SES::ReceiptRule.After.

Link

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

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

rule

AWS::SES::ReceiptRule.Rule.

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

AWS::SES::ReceiptRule.RuleSetName.

Link

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

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ActionProperty

class CfnReceiptRule.ActionProperty(*, add_header_action=None, bounce_action=None, lambda_action=None, s3_action=None, sns_action=None, stop_action=None, workmail_action=None)

Bases: object

Parameters
Link

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

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

action_property = 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"
    )
)

Attributes

add_header_action

CfnReceiptRule.ActionProperty.AddHeaderAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-addheaderaction

Return type

Union[IResolvable, AddHeaderActionProperty, None]

bounce_action

CfnReceiptRule.ActionProperty.BounceAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-bounceaction

Return type

Union[IResolvable, BounceActionProperty, None]

lambda_action

CfnReceiptRule.ActionProperty.LambdaAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-lambdaaction

Return type

Union[IResolvable, LambdaActionProperty, None]

s3_action

CfnReceiptRule.ActionProperty.S3Action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-s3action

Return type

Union[IResolvable, S3ActionProperty, None]

sns_action

CfnReceiptRule.ActionProperty.SNSAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-snsaction

Return type

Union[IResolvable, SNSActionProperty, None]

stop_action

CfnReceiptRule.ActionProperty.StopAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-stopaction

Return type

Union[IResolvable, StopActionProperty, None]

workmail_action

CfnReceiptRule.ActionProperty.WorkmailAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-workmailaction

Return type

Union[IResolvable, WorkmailActionProperty, None]

AddHeaderActionProperty

class CfnReceiptRule.AddHeaderActionProperty(*, header_name, header_value)

Bases: object

Parameters
  • header_name (str) – CfnReceiptRule.AddHeaderActionProperty.HeaderName.

  • header_value (str) – CfnReceiptRule.AddHeaderActionProperty.HeaderValue.

Link

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

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

add_header_action_property = ses.CfnReceiptRule.AddHeaderActionProperty(
    header_name="headerName",
    header_value="headerValue"
)

Attributes

header_name

CfnReceiptRule.AddHeaderActionProperty.HeaderName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headername

Return type

str

header_value

CfnReceiptRule.AddHeaderActionProperty.HeaderValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headervalue

Return type

str

BounceActionProperty

class CfnReceiptRule.BounceActionProperty(*, message, sender, smtp_reply_code, status_code=None, topic_arn=None)

Bases: object

Parameters
  • message (str) – CfnReceiptRule.BounceActionProperty.Message.

  • sender (str) – CfnReceiptRule.BounceActionProperty.Sender.

  • smtp_reply_code (str) – CfnReceiptRule.BounceActionProperty.SmtpReplyCode.

  • status_code (Optional[str]) – CfnReceiptRule.BounceActionProperty.StatusCode.

  • topic_arn (Optional[str]) – CfnReceiptRule.BounceActionProperty.TopicArn.

Link

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

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

bounce_action_property = ses.CfnReceiptRule.BounceActionProperty(
    message="message",
    sender="sender",
    smtp_reply_code="smtpReplyCode",

    # the properties below are optional
    status_code="statusCode",
    topic_arn="topicArn"
)

Attributes

message

CfnReceiptRule.BounceActionProperty.Message.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-message

Return type

str

sender

CfnReceiptRule.BounceActionProperty.Sender.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-sender

Return type

str

smtp_reply_code

CfnReceiptRule.BounceActionProperty.SmtpReplyCode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-smtpreplycode

Return type

str

status_code

CfnReceiptRule.BounceActionProperty.StatusCode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-statuscode

Return type

Optional[str]

topic_arn

CfnReceiptRule.BounceActionProperty.TopicArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-topicarn

Return type

Optional[str]

LambdaActionProperty

class CfnReceiptRule.LambdaActionProperty(*, function_arn, invocation_type=None, topic_arn=None)

Bases: object

Parameters
  • function_arn (str) – CfnReceiptRule.LambdaActionProperty.FunctionArn.

  • invocation_type (Optional[str]) – CfnReceiptRule.LambdaActionProperty.InvocationType.

  • topic_arn (Optional[str]) – CfnReceiptRule.LambdaActionProperty.TopicArn.

Link

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

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

lambda_action_property = ses.CfnReceiptRule.LambdaActionProperty(
    function_arn="functionArn",

    # the properties below are optional
    invocation_type="invocationType",
    topic_arn="topicArn"
)

Attributes

function_arn

CfnReceiptRule.LambdaActionProperty.FunctionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-functionarn

Return type

str

invocation_type

CfnReceiptRule.LambdaActionProperty.InvocationType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-invocationtype

Return type

Optional[str]

topic_arn

CfnReceiptRule.LambdaActionProperty.TopicArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-topicarn

Return type

Optional[str]

RuleProperty

class CfnReceiptRule.RuleProperty(*, actions=None, enabled=None, name=None, recipients=None, scan_enabled=None, tls_policy=None)

Bases: object

Parameters
  • actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty]], None]) – CfnReceiptRule.RuleProperty.Actions.

  • enabled (Union[bool, IResolvable, None]) – CfnReceiptRule.RuleProperty.Enabled.

  • name (Optional[str]) – CfnReceiptRule.RuleProperty.Name.

  • recipients (Optional[Sequence[str]]) – CfnReceiptRule.RuleProperty.Recipients.

  • scan_enabled (Union[bool, IResolvable, None]) – CfnReceiptRule.RuleProperty.ScanEnabled.

  • tls_policy (Optional[str]) – CfnReceiptRule.RuleProperty.TlsPolicy.

Link

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

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

rule_property = 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"
)

Attributes

actions

CfnReceiptRule.RuleProperty.Actions.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ActionProperty]], None]

enabled

CfnReceiptRule.RuleProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

name

CfnReceiptRule.RuleProperty.Name.

Link

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

Return type

Optional[str]

recipients

CfnReceiptRule.RuleProperty.Recipients.

Link

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

Return type

Optional[List[str]]

scan_enabled

CfnReceiptRule.RuleProperty.ScanEnabled.

Link

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

Return type

Union[bool, IResolvable, None]

tls_policy

CfnReceiptRule.RuleProperty.TlsPolicy.

Link

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

Return type

Optional[str]

S3ActionProperty

class CfnReceiptRule.S3ActionProperty(*, bucket_name, kms_key_arn=None, object_key_prefix=None, topic_arn=None)

Bases: object

Parameters
  • bucket_name (str) – CfnReceiptRule.S3ActionProperty.BucketName.

  • kms_key_arn (Optional[str]) – CfnReceiptRule.S3ActionProperty.KmsKeyArn.

  • object_key_prefix (Optional[str]) – CfnReceiptRule.S3ActionProperty.ObjectKeyPrefix.

  • topic_arn (Optional[str]) – CfnReceiptRule.S3ActionProperty.TopicArn.

Link

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

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

s3_action_property = ses.CfnReceiptRule.S3ActionProperty(
    bucket_name="bucketName",

    # the properties below are optional
    kms_key_arn="kmsKeyArn",
    object_key_prefix="objectKeyPrefix",
    topic_arn="topicArn"
)

Attributes

bucket_name

CfnReceiptRule.S3ActionProperty.BucketName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-bucketname

Return type

str

kms_key_arn

CfnReceiptRule.S3ActionProperty.KmsKeyArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-kmskeyarn

Return type

Optional[str]

object_key_prefix

CfnReceiptRule.S3ActionProperty.ObjectKeyPrefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-objectkeyprefix

Return type

Optional[str]

topic_arn

CfnReceiptRule.S3ActionProperty.TopicArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-topicarn

Return type

Optional[str]

SNSActionProperty

class CfnReceiptRule.SNSActionProperty(*, encoding=None, topic_arn=None)

Bases: object

Parameters
  • encoding (Optional[str]) – CfnReceiptRule.SNSActionProperty.Encoding.

  • topic_arn (Optional[str]) – CfnReceiptRule.SNSActionProperty.TopicArn.

Link

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

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

s_nSAction_property = ses.CfnReceiptRule.SNSActionProperty(
    encoding="encoding",
    topic_arn="topicArn"
)

Attributes

encoding

CfnReceiptRule.SNSActionProperty.Encoding.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-encoding

Return type

Optional[str]

topic_arn

CfnReceiptRule.SNSActionProperty.TopicArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn

Return type

Optional[str]

StopActionProperty

class CfnReceiptRule.StopActionProperty(*, scope, topic_arn=None)

Bases: object

Parameters
  • scope (str) – CfnReceiptRule.StopActionProperty.Scope.

  • topic_arn (Optional[str]) – CfnReceiptRule.StopActionProperty.TopicArn.

Link

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

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

stop_action_property = ses.CfnReceiptRule.StopActionProperty(
    scope="scope",

    # the properties below are optional
    topic_arn="topicArn"
)

Attributes

scope

CfnReceiptRule.StopActionProperty.Scope.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-scope

Return type

str

topic_arn

CfnReceiptRule.StopActionProperty.TopicArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-topicarn

Return type

Optional[str]

WorkmailActionProperty

class CfnReceiptRule.WorkmailActionProperty(*, organization_arn, topic_arn=None)

Bases: object

Parameters
  • organization_arn (str) – CfnReceiptRule.WorkmailActionProperty.OrganizationArn.

  • topic_arn (Optional[str]) – CfnReceiptRule.WorkmailActionProperty.TopicArn.

Link

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

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

workmail_action_property = ses.CfnReceiptRule.WorkmailActionProperty(
    organization_arn="organizationArn",

    # the properties below are optional
    topic_arn="topicArn"
)

Attributes

organization_arn

CfnReceiptRule.WorkmailActionProperty.OrganizationArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-organizationarn

Return type

str

topic_arn

CfnReceiptRule.WorkmailActionProperty.TopicArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-topicarn

Return type

Optional[str]