CfnMailManagerRuleSetPropsMixin

class aws_cdk.mixins_preview.aws_ses.mixins.CfnMailManagerRuleSetPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html
CloudformationResource:: AWS::SES::MailManagerRuleSet
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# drop: Any

cfn_mail_manager_rule_set_props_mixin = ses_mixins.CfnMailManagerRuleSetPropsMixin(ses_mixins.CfnMailManagerRuleSetMixinProps(
    rules=[ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleProperty(
        actions=[ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleActionProperty(
            add_header=ses_mixins.CfnMailManagerRuleSetPropsMixin.AddHeaderActionProperty(
                header_name="headerName",
                header_value="headerValue"
            ),
            archive=ses_mixins.CfnMailManagerRuleSetPropsMixin.ArchiveActionProperty(
                action_failure_policy="actionFailurePolicy",
                target_archive="targetArchive"
            ),
            deliver_to_mailbox=ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToMailboxActionProperty(
                action_failure_policy="actionFailurePolicy",
                mailbox_arn="mailboxArn",
                role_arn="roleArn"
            ),
            deliver_to_qBusiness=ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty(
                action_failure_policy="actionFailurePolicy",
                application_id="applicationId",
                index_id="indexId",
                role_arn="roleArn"
            ),
            drop=drop,
            publish_to_sns=ses_mixins.CfnMailManagerRuleSetPropsMixin.SnsActionProperty(
                action_failure_policy="actionFailurePolicy",
                encoding="encoding",
                payload_type="payloadType",
                role_arn="roleArn",
                topic_arn="topicArn"
            ),
            relay=ses_mixins.CfnMailManagerRuleSetPropsMixin.RelayActionProperty(
                action_failure_policy="actionFailurePolicy",
                mail_from="mailFrom",
                relay="relay"
            ),
            replace_recipient=ses_mixins.CfnMailManagerRuleSetPropsMixin.ReplaceRecipientActionProperty(
                replace_with=["replaceWith"]
            ),
            send=ses_mixins.CfnMailManagerRuleSetPropsMixin.SendActionProperty(
                action_failure_policy="actionFailurePolicy",
                role_arn="roleArn"
            ),
            write_to_s3=ses_mixins.CfnMailManagerRuleSetPropsMixin.S3ActionProperty(
                action_failure_policy="actionFailurePolicy",
                role_arn="roleArn",
                s3_bucket="s3Bucket",
                s3_prefix="s3Prefix",
                s3_sse_kms_key_id="s3SseKmsKeyId"
            )
        )],
        conditions=[ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleConditionProperty(
            boolean_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(
                    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute",
                    is_in_address_list=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
                        address_lists=["addressLists"],
                        attribute="attribute"
                    )
                ),
                operator="operator"
            ),
            dmarc_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleDmarcExpressionProperty(
                operator="operator",
                values=["values"]
            ),
            ip_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            ),
            number_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                value=123
            ),
            string_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(
                    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute",
                    mime_header_attribute="mimeHeaderAttribute"
                ),
                operator="operator",
                values=["values"]
            ),
            verdict_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(
                    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            )
        )],
        name="name",
        unless=[ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleConditionProperty(
            boolean_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(
                    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute",
                    is_in_address_list=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
                        address_lists=["addressLists"],
                        attribute="attribute"
                    )
                ),
                operator="operator"
            ),
            dmarc_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleDmarcExpressionProperty(
                operator="operator",
                values=["values"]
            ),
            ip_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            ),
            number_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                value=123
            ),
            string_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(
                    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute",
                    mime_header_attribute="mimeHeaderAttribute"
                ),
                operator="operator",
                values=["values"]
            ),
            verdict_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictExpressionProperty(
                evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(
                    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            )
        )]
    )],
    rule_set_name="ruleSetName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SES::MailManagerRuleSet.

Parameters:

props (Union[CfnMailManagerRuleSetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['rules', 'ruleSetName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

AddHeaderActionProperty

class CfnMailManagerRuleSetPropsMixin.AddHeaderActionProperty(*, header_name=None, header_value=None)

Bases: object

The action to add a header to a message.

When executed, this action will add the given header to the message.

Parameters:

header_name (Optional[str]) – The name of the header to add to an email. The header must be prefixed with “X-”. Headers are added regardless of whether the header name pre-existed in the email.
header_value (Optional[str]) – The value of the header to add to the email.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-addheaderaction.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

add_header_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.AddHeaderActionProperty(
    header_name="headerName",
    header_value="headerValue"
)

Attributes

header_name

The name of the header to add to an email.

The header must be prefixed with “X-”. Headers are added regardless of whether the header name pre-existed in the email.

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

header_value

The value of the header to add to the email.

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

AnalysisProperty

class CfnMailManagerRuleSetPropsMixin.AnalysisProperty(*, analyzer=None, result_field=None)

Bases: object

The result of an analysis can be used in conditions to trigger actions.

Analyses can inspect the email content and report a certain aspect of the email.

Parameters:

analyzer (Optional[str]) – The Amazon Resource Name (ARN) of an Add On.
result_field (Optional[str]) – The returned value from an Add On.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-analysis.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

analysis_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
    analyzer="analyzer",
    result_field="resultField"
)

Attributes

analyzer

The Amazon Resource Name (ARN) of an Add On.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-analysis.html#cfn-ses-mailmanagerruleset-analysis-analyzer

result_field

The returned value from an Add On.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-analysis.html#cfn-ses-mailmanagerruleset-analysis-resultfield

ArchiveActionProperty

class CfnMailManagerRuleSetPropsMixin.ArchiveActionProperty(*, action_failure_policy=None, target_archive=None)

Bases: object

The action to archive the email by delivering the email to an Amazon SES archive.

Parameters:

action_failure_policy (Optional[str]) – A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.
target_archive (Optional[str]) – The identifier of the archive to send the email to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.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

archive_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.ArchiveActionProperty(
    action_failure_policy="actionFailurePolicy",
    target_archive="targetArchive"
)

Attributes

action_failure_policy

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the specified archive has been deleted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.html#cfn-ses-mailmanagerruleset-archiveaction-actionfailurepolicy

target_archive

The identifier of the archive to send the email to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.html#cfn-ses-mailmanagerruleset-archiveaction-targetarchive

DeliverToMailboxActionProperty

class CfnMailManagerRuleSetPropsMixin.DeliverToMailboxActionProperty(*, action_failure_policy=None, mailbox_arn=None, role_arn=None)

Bases: object

This action to delivers an email to a mailbox.

Parameters:

action_failure_policy (Optional[str]) – A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.
mailbox_arn (Optional[str]) – The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.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

deliver_to_mailbox_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToMailboxActionProperty(
    action_failure_policy="actionFailurePolicy",
    mailbox_arn="mailboxArn",
    role_arn="roleArn"
)

Attributes

action_failure_policy

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html#cfn-ses-mailmanagerruleset-delivertomailboxaction-actionfailurepolicy

mailbox_arn

The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html#cfn-ses-mailmanagerruleset-delivertomailboxaction-mailboxarn

role_arn

The Amazon Resource Name (ARN) of an IAM role to use to execute this action.

The role must have access to the workmail:DeliverToMailbox API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertomailboxaction.html#cfn-ses-mailmanagerruleset-delivertomailboxaction-rolearn

DeliverToQBusinessActionProperty

class CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty(*, action_failure_policy=None, application_id=None, index_id=None, role_arn=None)

Bases: object

The action to deliver incoming emails to an Amazon Q Business application for indexing.

Parameters:

action_failure_policy (Optional[str]) – A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.
application_id (Optional[str]) – The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
index_id (Optional[str]) – The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.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

deliver_to_qBusiness_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty(
    action_failure_policy="actionFailurePolicy",
    application_id="applicationId",
    index_id="indexId",
    role_arn="roleArn"
)

Attributes

action_failure_policy

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-actionfailurepolicy

application_id

The unique identifier of the Amazon Q Business application instance where the email content will be delivered.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-applicationid

index_id

The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-indexid

role_arn

The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business.

This role must have access to the qbusiness:BatchPutDocument API for the given application and index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-rolearn

RelayActionProperty

class CfnMailManagerRuleSetPropsMixin.RelayActionProperty(*, action_failure_policy=None, mail_from=None, relay=None)

Bases: object

The action relays the email via SMTP to another specific SMTP server.

Parameters:

action_failure_policy (Optional[str]) – A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.
mail_from (Optional[str]) – This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.
relay (Optional[str]) – The identifier of the relay resource to be used when relaying an email.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.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

relay_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RelayActionProperty(
    action_failure_policy="actionFailurePolicy",
    mail_from="mailFrom",
    relay="relay"
)

Attributes

action_failure_policy

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the specified relay has been deleted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.html#cfn-ses-mailmanagerruleset-relayaction-actionfailurepolicy

mail_from

This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.html#cfn-ses-mailmanagerruleset-relayaction-mailfrom

relay

The identifier of the relay resource to be used when relaying an email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-relayaction.html#cfn-ses-mailmanagerruleset-relayaction-relay

ReplaceRecipientActionProperty

class CfnMailManagerRuleSetPropsMixin.ReplaceRecipientActionProperty(*, replace_with=None)

Bases: object

This action replaces the email envelope recipients with the given list of recipients.

If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.

Parameters:: replace_with (Optional[Sequence[str]]) – This action specifies the replacement recipient email addresses to insert.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-replacerecipientaction.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

replace_recipient_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.ReplaceRecipientActionProperty(
    replace_with=["replaceWith"]
)

Attributes

replace_with

This action specifies the replacement recipient email addresses to insert.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-replacerecipientaction.html#cfn-ses-mailmanagerruleset-replacerecipientaction-replacewith

RuleActionProperty

class CfnMailManagerRuleSetPropsMixin.RuleActionProperty(*, add_header=None, archive=None, deliver_to_mailbox=None, deliver_to_q_business=None, drop=None, publish_to_sns=None, relay=None, replace_recipient=None, send=None, write_to_s3=None)

Bases: object

The action for a rule to take. Only one of the contained actions can be set.

This data type is a UNION, so only one of the following members can be specified when used or returned.

Parameters:

add_header (Union[IResolvable, AddHeaderActionProperty, Dict[str, Any], None]) – This action adds a header. This can be used to add arbitrary email headers.
archive (Union[IResolvable, ArchiveActionProperty, Dict[str, Any], None]) – This action archives the email. This can be used to deliver an email to an archive.
deliver_to_mailbox (Union[IResolvable, DeliverToMailboxActionProperty, Dict[str, Any], None]) – This action delivers an email to a WorkMail mailbox.
deliver_to_q_business (Union[IResolvable, DeliverToQBusinessActionProperty, Dict[str, Any], None]) – This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
drop (Any) – This action terminates the evaluation of rules in the rule set.
publish_to_sns (Union[IResolvable, SnsActionProperty, Dict[str, Any], None]) – This action publishes the email content to an Amazon SNS topic.
relay (Union[IResolvable, RelayActionProperty, Dict[str, Any], None]) – This action relays the email to another SMTP server.
replace_recipient (Union[IResolvable, ReplaceRecipientActionProperty, Dict[str, Any], None]) – The action replaces certain or all recipients with a different set of recipients.
send (Union[IResolvable, SendActionProperty, Dict[str, Any], None]) – This action sends the email to the internet.
write_to_s3 (Union[IResolvable, S3ActionProperty, Dict[str, Any], None]) – This action writes the MIME content of the email to an S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.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

# drop: Any

rule_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleActionProperty(
    add_header=ses_mixins.CfnMailManagerRuleSetPropsMixin.AddHeaderActionProperty(
        header_name="headerName",
        header_value="headerValue"
    ),
    archive=ses_mixins.CfnMailManagerRuleSetPropsMixin.ArchiveActionProperty(
        action_failure_policy="actionFailurePolicy",
        target_archive="targetArchive"
    ),
    deliver_to_mailbox=ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToMailboxActionProperty(
        action_failure_policy="actionFailurePolicy",
        mailbox_arn="mailboxArn",
        role_arn="roleArn"
    ),
    deliver_to_qBusiness=ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty(
        action_failure_policy="actionFailurePolicy",
        application_id="applicationId",
        index_id="indexId",
        role_arn="roleArn"
    ),
    drop=drop,
    publish_to_sns=ses_mixins.CfnMailManagerRuleSetPropsMixin.SnsActionProperty(
        action_failure_policy="actionFailurePolicy",
        encoding="encoding",
        payload_type="payloadType",
        role_arn="roleArn",
        topic_arn="topicArn"
    ),
    relay=ses_mixins.CfnMailManagerRuleSetPropsMixin.RelayActionProperty(
        action_failure_policy="actionFailurePolicy",
        mail_from="mailFrom",
        relay="relay"
    ),
    replace_recipient=ses_mixins.CfnMailManagerRuleSetPropsMixin.ReplaceRecipientActionProperty(
        replace_with=["replaceWith"]
    ),
    send=ses_mixins.CfnMailManagerRuleSetPropsMixin.SendActionProperty(
        action_failure_policy="actionFailurePolicy",
        role_arn="roleArn"
    ),
    write_to_s3=ses_mixins.CfnMailManagerRuleSetPropsMixin.S3ActionProperty(
        action_failure_policy="actionFailurePolicy",
        role_arn="roleArn",
        s3_bucket="s3Bucket",
        s3_prefix="s3Prefix",
        s3_sse_kms_key_id="s3SseKmsKeyId"
    )
)

Attributes

add_header

This action adds a header.

This can be used to add arbitrary email headers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-addheader

archive

This action archives the email.

This can be used to deliver an email to an archive.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-archive

deliver_to_mailbox

This action delivers an email to a WorkMail mailbox.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-delivertomailbox

deliver_to_q_business

This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-delivertoqbusiness

drop

This action terminates the evaluation of rules in the rule set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-drop

publish_to_sns

This action publishes the email content to an Amazon SNS topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-publishtosns

relay

This action relays the email to another SMTP server.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-relay

replace_recipient

The action replaces certain or all recipients with a different set of recipients.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-replacerecipient

send

This action sends the email to the internet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-send

write_to_s3

This action writes the MIME content of the email to an S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleaction.html#cfn-ses-mailmanagerruleset-ruleaction-writetos3

RuleBooleanExpressionProperty

class CfnMailManagerRuleSetPropsMixin.RuleBooleanExpressionProperty(*, evaluate=None, operator=None)

Bases: object

A boolean expression to be used in a rule condition.

Parameters:

evaluate (Union[IResolvable, RuleBooleanToEvaluateProperty, Dict[str, Any], None]) – The operand on which to perform a boolean condition operation.
operator (Optional[str]) – The matching operator for a boolean condition expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleanexpression.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

rule_boolean_expression_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanExpressionProperty(
    evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(
        analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
            analyzer="analyzer",
            result_field="resultField"
        ),
        attribute="attribute",
        is_in_address_list=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
            address_lists=["addressLists"],
            attribute="attribute"
        )
    ),
    operator="operator"
)

Attributes

evaluate

The operand on which to perform a boolean condition operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleanexpression.html#cfn-ses-mailmanagerruleset-rulebooleanexpression-evaluate

operator

The matching operator for a boolean condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleanexpression.html#cfn-ses-mailmanagerruleset-rulebooleanexpression-operator

RuleBooleanToEvaluateProperty

class CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(*, analysis=None, attribute=None, is_in_address_list=None)

Bases: object

The union type representing the allowed types of operands for a boolean condition.

Parameters:

analysis (Union[IResolvable, AnalysisProperty, Dict[str, Any], None]) – The Add On ARN and its returned value to evaluate in a boolean condition expression.
attribute (Optional[str]) – The boolean type representing the allowed attribute types for an email.
is_in_address_list (Union[IResolvable, RuleIsInAddressListProperty, Dict[str, Any], None]) – The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.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

rule_boolean_to_evaluate_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(
    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
        analyzer="analyzer",
        result_field="resultField"
    ),
    attribute="attribute",
    is_in_address_list=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
        address_lists=["addressLists"],
        attribute="attribute"
    )
)

Attributes

analysis

The Add On ARN and its returned value to evaluate in a boolean condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html#cfn-ses-mailmanagerruleset-rulebooleantoevaluate-analysis

attribute

The boolean type representing the allowed attribute types for an email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html#cfn-ses-mailmanagerruleset-rulebooleantoevaluate-attribute

is_in_address_list

The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulebooleantoevaluate.html#cfn-ses-mailmanagerruleset-rulebooleantoevaluate-isinaddresslist

RuleConditionProperty

class CfnMailManagerRuleSetPropsMixin.RuleConditionProperty(*, boolean_expression=None, dmarc_expression=None, ip_expression=None, number_expression=None, string_expression=None, verdict_expression=None)

Bases: object

The conditional expression used to evaluate an email for determining if a rule action should be taken.

This data type is a UNION, so only one of the following members can be specified when used or returned.

Parameters:

boolean_expression (Union[IResolvable, RuleBooleanExpressionProperty, Dict[str, Any], None]) – The condition applies to a boolean expression passed in this field.
dmarc_expression (Union[IResolvable, RuleDmarcExpressionProperty, Dict[str, Any], None]) – The condition applies to a DMARC policy expression passed in this field.
ip_expression (Union[IResolvable, RuleIpExpressionProperty, Dict[str, Any], None]) – The condition applies to an IP address expression passed in this field.
number_expression (Union[IResolvable, RuleNumberExpressionProperty, Dict[str, Any], None]) – The condition applies to a number expression passed in this field.
string_expression (Union[IResolvable, RuleStringExpressionProperty, Dict[str, Any], None]) – The condition applies to a string expression passed in this field.
verdict_expression (Union[IResolvable, RuleVerdictExpressionProperty, Dict[str, Any], None]) – The condition applies to a verdict expression passed in this field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.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

rule_condition_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleConditionProperty(
    boolean_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanExpressionProperty(
        evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(
            analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                analyzer="analyzer",
                result_field="resultField"
            ),
            attribute="attribute",
            is_in_address_list=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
                address_lists=["addressLists"],
                attribute="attribute"
            )
        ),
        operator="operator"
    ),
    dmarc_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleDmarcExpressionProperty(
        operator="operator",
        values=["values"]
    ),
    ip_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpExpressionProperty(
        evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(
            attribute="attribute"
        ),
        operator="operator",
        values=["values"]
    ),
    number_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberExpressionProperty(
        evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(
            attribute="attribute"
        ),
        operator="operator",
        value=123
    ),
    string_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringExpressionProperty(
        evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(
            analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                analyzer="analyzer",
                result_field="resultField"
            ),
            attribute="attribute",
            mime_header_attribute="mimeHeaderAttribute"
        ),
        operator="operator",
        values=["values"]
    ),
    verdict_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictExpressionProperty(
        evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(
            analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                analyzer="analyzer",
                result_field="resultField"
            ),
            attribute="attribute"
        ),
        operator="operator",
        values=["values"]
    )
)

Attributes

boolean_expression

The condition applies to a boolean expression passed in this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-booleanexpression

dmarc_expression

The condition applies to a DMARC policy expression passed in this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-dmarcexpression

ip_expression

The condition applies to an IP address expression passed in this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-ipexpression

number_expression

The condition applies to a number expression passed in this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-numberexpression

string_expression

The condition applies to a string expression passed in this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-stringexpression

verdict_expression

The condition applies to a verdict expression passed in this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulecondition.html#cfn-ses-mailmanagerruleset-rulecondition-verdictexpression

RuleDmarcExpressionProperty

class CfnMailManagerRuleSetPropsMixin.RuleDmarcExpressionProperty(*, operator=None, values=None)

Bases: object

A DMARC policy expression.

The condition matches if the given DMARC policy matches that of the incoming email.

Parameters:

operator (Optional[str]) – The operator to apply to the DMARC policy of the incoming email.
values (Optional[Sequence[str]]) – The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email’s DMARC policy is not equal to any of the given values, then the condition is deemed to match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruledmarcexpression.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

rule_dmarc_expression_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleDmarcExpressionProperty(
    operator="operator",
    values=["values"]
)

Attributes

operator

The operator to apply to the DMARC policy of the incoming email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruledmarcexpression.html#cfn-ses-mailmanagerruleset-ruledmarcexpression-operator

values

The values to use for the given DMARC policy operator.

For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email’s DMARC policy is not equal to any of the given values, then the condition is deemed to match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruledmarcexpression.html#cfn-ses-mailmanagerruleset-ruledmarcexpression-values

RuleIpExpressionProperty

class CfnMailManagerRuleSetPropsMixin.RuleIpExpressionProperty(*, evaluate=None, operator=None, values=None)

Bases: object

An IP address expression matching certain IP addresses within a given range of IP addresses.

Parameters:

evaluate (Union[IResolvable, RuleIpToEvaluateProperty, Dict[str, Any], None]) – The IP address to evaluate in this condition.
operator (Optional[str]) – The operator to evaluate the IP address.
values (Optional[Sequence[str]]) – The IP CIDR blocks in format “x.y.z.w/n” (eg 10.0.0.0/8) to match with the email’s IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.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

rule_ip_expression_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpExpressionProperty(
    evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(
        attribute="attribute"
    ),
    operator="operator",
    values=["values"]
)

Attributes

evaluate

The IP address to evaluate in this condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.html#cfn-ses-mailmanagerruleset-ruleipexpression-evaluate

operator

The operator to evaluate the IP address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.html#cfn-ses-mailmanagerruleset-ruleipexpression-operator

values

The IP CIDR blocks in format “x.y.z.w/n” (eg 10.0.0.0/8) to match with the email’s IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleipexpression.html#cfn-ses-mailmanagerruleset-ruleipexpression-values

RuleIpToEvaluateProperty

class CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(*, attribute=None)

Bases: object

The IP address to evaluate for this condition.

Parameters:: attribute (Optional[str]) – The attribute of the email to evaluate.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleiptoevaluate.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

rule_ip_to_evaluate_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(
    attribute="attribute"
)

Attributes

attribute

The attribute of the email to evaluate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleiptoevaluate.html#cfn-ses-mailmanagerruleset-ruleiptoevaluate-attribute

RuleIsInAddressListProperty

class CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(*, address_lists=None, attribute=None)

Bases: object

The structure type for a boolean condition that provides the address lists and address list attribute to evaluate.

Parameters:

address_lists (Optional[Sequence[str]]) – The address lists that will be used for evaluation.
attribute (Optional[str]) – The email attribute that needs to be evaluated against the address list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleisinaddresslist.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

rule_is_in_address_list_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
    address_lists=["addressLists"],
    attribute="attribute"
)

Attributes

address_lists

The address lists that will be used for evaluation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleisinaddresslist.html#cfn-ses-mailmanagerruleset-ruleisinaddresslist-addresslists

attribute

The email attribute that needs to be evaluated against the address list.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleisinaddresslist.html#cfn-ses-mailmanagerruleset-ruleisinaddresslist-attribute

RuleNumberExpressionProperty

class CfnMailManagerRuleSetPropsMixin.RuleNumberExpressionProperty(*, evaluate=None, operator=None, value=None)

Bases: object

A number expression to match numeric conditions with integers from the incoming email.

Parameters:

evaluate (Union[IResolvable, RuleNumberToEvaluateProperty, Dict[str, Any], None]) – The number to evaluate in a numeric condition expression.
operator (Optional[str]) – The operator for a numeric condition expression.
value (Union[int, float, None]) – The value to evaluate in a numeric condition expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.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

rule_number_expression_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberExpressionProperty(
    evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(
        attribute="attribute"
    ),
    operator="operator",
    value=123
)

Attributes

evaluate

The number to evaluate in a numeric condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.html#cfn-ses-mailmanagerruleset-rulenumberexpression-evaluate

operator

The operator for a numeric condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.html#cfn-ses-mailmanagerruleset-rulenumberexpression-operator

value

The value to evaluate in a numeric condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumberexpression.html#cfn-ses-mailmanagerruleset-rulenumberexpression-value

RuleNumberToEvaluateProperty

class CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(*, attribute=None)

Bases: object

The number to evaluate in a numeric condition expression.

Parameters:: attribute (Optional[str]) – An email attribute that is used as the number to evaluate.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumbertoevaluate.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

rule_number_to_evaluate_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(
    attribute="attribute"
)

Attributes

attribute

An email attribute that is used as the number to evaluate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulenumbertoevaluate.html#cfn-ses-mailmanagerruleset-rulenumbertoevaluate-attribute

RuleProperty

class CfnMailManagerRuleSetPropsMixin.RuleProperty(*, actions=None, conditions=None, name=None, unless=None)

Bases: object

A rule contains conditions, “unless conditions” and actions.

For each envelope recipient of an email, if all conditions match and none of the “unless conditions” match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only “unless conditions” are provided, the rule applies if the email does not match the evaluation of the “unless conditions”.

Parameters:

actions (Union[IResolvable, Sequence[Union[IResolvable, RuleActionProperty, Dict[str, Any]]], None]) – The list of actions to execute when the conditions match the incoming email, and none of the “unless conditions” match.
conditions (Union[IResolvable, Sequence[Union[IResolvable, RuleConditionProperty, Dict[str, Any]]], None]) – The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any “unless conditions”
name (Optional[str]) – The user-friendly name of the rule.
unless (Union[IResolvable, Sequence[Union[IResolvable, RuleConditionProperty, Dict[str, Any]]], None]) – The “unless conditions” of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.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

# drop: Any

rule_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleProperty(
    actions=[ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleActionProperty(
        add_header=ses_mixins.CfnMailManagerRuleSetPropsMixin.AddHeaderActionProperty(
            header_name="headerName",
            header_value="headerValue"
        ),
        archive=ses_mixins.CfnMailManagerRuleSetPropsMixin.ArchiveActionProperty(
            action_failure_policy="actionFailurePolicy",
            target_archive="targetArchive"
        ),
        deliver_to_mailbox=ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToMailboxActionProperty(
            action_failure_policy="actionFailurePolicy",
            mailbox_arn="mailboxArn",
            role_arn="roleArn"
        ),
        deliver_to_qBusiness=ses_mixins.CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty(
            action_failure_policy="actionFailurePolicy",
            application_id="applicationId",
            index_id="indexId",
            role_arn="roleArn"
        ),
        drop=drop,
        publish_to_sns=ses_mixins.CfnMailManagerRuleSetPropsMixin.SnsActionProperty(
            action_failure_policy="actionFailurePolicy",
            encoding="encoding",
            payload_type="payloadType",
            role_arn="roleArn",
            topic_arn="topicArn"
        ),
        relay=ses_mixins.CfnMailManagerRuleSetPropsMixin.RelayActionProperty(
            action_failure_policy="actionFailurePolicy",
            mail_from="mailFrom",
            relay="relay"
        ),
        replace_recipient=ses_mixins.CfnMailManagerRuleSetPropsMixin.ReplaceRecipientActionProperty(
            replace_with=["replaceWith"]
        ),
        send=ses_mixins.CfnMailManagerRuleSetPropsMixin.SendActionProperty(
            action_failure_policy="actionFailurePolicy",
            role_arn="roleArn"
        ),
        write_to_s3=ses_mixins.CfnMailManagerRuleSetPropsMixin.S3ActionProperty(
            action_failure_policy="actionFailurePolicy",
            role_arn="roleArn",
            s3_bucket="s3Bucket",
            s3_prefix="s3Prefix",
            s3_sse_kms_key_id="s3SseKmsKeyId"
        )
    )],
    conditions=[ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleConditionProperty(
        boolean_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(
                analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                    analyzer="analyzer",
                    result_field="resultField"
                ),
                attribute="attribute",
                is_in_address_list=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
                    address_lists=["addressLists"],
                    attribute="attribute"
                )
            ),
            operator="operator"
        ),
        dmarc_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleDmarcExpressionProperty(
            operator="operator",
            values=["values"]
        ),
        ip_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            values=["values"]
        ),
        number_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            value=123
        ),
        string_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(
                analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                    analyzer="analyzer",
                    result_field="resultField"
                ),
                attribute="attribute",
                mime_header_attribute="mimeHeaderAttribute"
            ),
            operator="operator",
            values=["values"]
        ),
        verdict_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(
                analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                    analyzer="analyzer",
                    result_field="resultField"
                ),
                attribute="attribute"
            ),
            operator="operator",
            values=["values"]
        )
    )],
    name="name",
    unless=[ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleConditionProperty(
        boolean_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleBooleanToEvaluateProperty(
                analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                    analyzer="analyzer",
                    result_field="resultField"
                ),
                attribute="attribute",
                is_in_address_list=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIsInAddressListProperty(
                    address_lists=["addressLists"],
                    attribute="attribute"
                )
            ),
            operator="operator"
        ),
        dmarc_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleDmarcExpressionProperty(
            operator="operator",
            values=["values"]
        ),
        ip_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleIpToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            values=["values"]
        ),
        number_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleNumberToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            value=123
        ),
        string_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(
                analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                    analyzer="analyzer",
                    result_field="resultField"
                ),
                attribute="attribute",
                mime_header_attribute="mimeHeaderAttribute"
            ),
            operator="operator",
            values=["values"]
        ),
        verdict_expression=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictExpressionProperty(
            evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(
                analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
                    analyzer="analyzer",
                    result_field="resultField"
                ),
                attribute="attribute"
            ),
            operator="operator",
            values=["values"]
        )
    )]
)

Attributes

actions

The list of actions to execute when the conditions match the incoming email, and none of the “unless conditions” match.

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

conditions

The conditions of this rule.

All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any “unless conditions”

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.html#cfn-ses-mailmanagerruleset-rule-conditions

name

The user-friendly name of the rule.

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

unless

The “unless conditions” of this rule.

None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rule.html#cfn-ses-mailmanagerruleset-rule-unless

RuleStringExpressionProperty

class CfnMailManagerRuleSetPropsMixin.RuleStringExpressionProperty(*, evaluate=None, operator=None, values=None)

Bases: object

A string expression is evaluated against strings or substrings of the email.

Parameters:

evaluate (Union[IResolvable, RuleStringToEvaluateProperty, Dict[str, Any], None]) – The string to evaluate in a string condition expression.
operator (Optional[str]) – The matching operator for a string condition expression.
values (Optional[Sequence[str]]) – The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email’s string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email’s string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.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

rule_string_expression_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringExpressionProperty(
    evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(
        analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
            analyzer="analyzer",
            result_field="resultField"
        ),
        attribute="attribute",
        mime_header_attribute="mimeHeaderAttribute"
    ),
    operator="operator",
    values=["values"]
)

Attributes

evaluate

The string to evaluate in a string condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.html#cfn-ses-mailmanagerruleset-rulestringexpression-evaluate

operator

The matching operator for a string condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.html#cfn-ses-mailmanagerruleset-rulestringexpression-operator

values

The string(s) to be evaluated in a string condition expression.

For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email’s string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email’s string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringexpression.html#cfn-ses-mailmanagerruleset-rulestringexpression-values

RuleStringToEvaluateProperty

class CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(*, analysis=None, attribute=None, mime_header_attribute=None)

Bases: object

The string to evaluate in a string condition expression.

This data type is a UNION, so only one of the following members can be specified when used or returned.

Parameters:

analysis (Union[IResolvable, AnalysisProperty, Dict[str, Any], None]) – The Add On ARN and its returned value to evaluate in a string condition expression.
attribute (Optional[str]) – The email attribute to evaluate in a string condition expression.
mime_header_attribute (Optional[str]) – The email MIME X-Header attribute to evaluate in a string condition expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.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

rule_string_to_evaluate_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleStringToEvaluateProperty(
    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
        analyzer="analyzer",
        result_field="resultField"
    ),
    attribute="attribute",
    mime_header_attribute="mimeHeaderAttribute"
)

Attributes

analysis

The Add On ARN and its returned value to evaluate in a string condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html#cfn-ses-mailmanagerruleset-rulestringtoevaluate-analysis

attribute

The email attribute to evaluate in a string condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html#cfn-ses-mailmanagerruleset-rulestringtoevaluate-attribute

mime_header_attribute

The email MIME X-Header attribute to evaluate in a string condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-rulestringtoevaluate.html#cfn-ses-mailmanagerruleset-rulestringtoevaluate-mimeheaderattribute

RuleVerdictExpressionProperty

class CfnMailManagerRuleSetPropsMixin.RuleVerdictExpressionProperty(*, evaluate=None, operator=None, values=None)

Bases: object

A verdict expression is evaluated against verdicts of the email.

Parameters:

evaluate (Union[IResolvable, RuleVerdictToEvaluateProperty, Dict[str, Any], None]) – The verdict to evaluate in a verdict condition expression.
operator (Optional[str]) – The matching operator for a verdict condition expression.
values (Optional[Sequence[str]]) – The values to match with the email’s verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.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

rule_verdict_expression_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictExpressionProperty(
    evaluate=ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(
        analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
            analyzer="analyzer",
            result_field="resultField"
        ),
        attribute="attribute"
    ),
    operator="operator",
    values=["values"]
)

Attributes

evaluate

The verdict to evaluate in a verdict condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html#cfn-ses-mailmanagerruleset-ruleverdictexpression-evaluate

operator

The matching operator for a verdict condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html#cfn-ses-mailmanagerruleset-ruleverdictexpression-operator

values

The values to match with the email’s verdict using the given operator.

For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdictexpression.html#cfn-ses-mailmanagerruleset-ruleverdictexpression-values

RuleVerdictToEvaluateProperty

class CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(*, analysis=None, attribute=None)

Bases: object

The verdict to evaluate in a verdict condition expression.

This data type is a UNION, so only one of the following members can be specified when used or returned.

Parameters:

analysis (Union[IResolvable, AnalysisProperty, Dict[str, Any], None]) – The Add On ARN and its returned value to evaluate in a verdict condition expression.
attribute (Optional[str]) – The email verdict attribute to evaluate in a string verdict expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdicttoevaluate.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

rule_verdict_to_evaluate_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.RuleVerdictToEvaluateProperty(
    analysis=ses_mixins.CfnMailManagerRuleSetPropsMixin.AnalysisProperty(
        analyzer="analyzer",
        result_field="resultField"
    ),
    attribute="attribute"
)

Attributes

analysis

The Add On ARN and its returned value to evaluate in a verdict condition expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdicttoevaluate.html#cfn-ses-mailmanagerruleset-ruleverdicttoevaluate-analysis

attribute

The email verdict attribute to evaluate in a string verdict expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-ruleverdicttoevaluate.html#cfn-ses-mailmanagerruleset-ruleverdicttoevaluate-attribute

S3ActionProperty

class CfnMailManagerRuleSetPropsMixin.S3ActionProperty(*, action_failure_policy=None, role_arn=None, s3_bucket=None, s3_prefix=None, s3_sse_kms_key_id=None)

Bases: object

Writes the MIME content of the email to an S3 bucket.

Parameters:

action_failure_policy (Optional[str]) – A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
s3_bucket (Optional[str]) – The bucket name of the S3 bucket to write to.
s3_prefix (Optional[str]) – The S3 prefix to use for the write to the s3 bucket.
s3_sse_kms_key_id (Optional[str]) – The KMS Key ID to use to encrypt the message in S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.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

s3_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.S3ActionProperty(
    action_failure_policy="actionFailurePolicy",
    role_arn="roleArn",
    s3_bucket="s3Bucket",
    s3_prefix="s3Prefix",
    s3_sse_kms_key_id="s3SseKmsKeyId"
)

Attributes

action_failure_policy

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-actionfailurepolicy

role_arn

The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3.

This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-rolearn

s3_bucket

The bucket name of the S3 bucket to write to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-s3bucket

s3_prefix

The S3 prefix to use for the write to the s3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-s3prefix

s3_sse_kms_key_id

The KMS Key ID to use to encrypt the message in S3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-s3action.html#cfn-ses-mailmanagerruleset-s3action-s3ssekmskeyid

SendActionProperty

class CfnMailManagerRuleSetPropsMixin.SendActionProperty(*, action_failure_policy=None, role_arn=None)

Bases: object

Sends the email to the internet using the ses:SendRawEmail API.

Parameters:

action_failure_policy (Optional[str]) – A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-sendaction.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

send_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.SendActionProperty(
    action_failure_policy="actionFailurePolicy",
    role_arn="roleArn"
)

Attributes

action_failure_policy

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-sendaction.html#cfn-ses-mailmanagerruleset-sendaction-actionfailurepolicy

role_arn

The Amazon Resource Name (ARN) of the role to use for this action.

This role must have access to the ses:SendRawEmail API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-sendaction.html#cfn-ses-mailmanagerruleset-sendaction-rolearn

SnsActionProperty

class CfnMailManagerRuleSetPropsMixin.SnsActionProperty(*, action_failure_policy=None, encoding=None, payload_type=None, role_arn=None, topic_arn=None)

Bases: object

The action to publish the email content to an Amazon SNS topic.

When executed, this action will send the email as a notification to the specified SNS topic.

Parameters:

action_failure_policy (Optional[str]) – A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the sns:Publish API.
encoding (Optional[str]) – The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8 . Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
payload_type (Optional[str]) – The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT .
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the sns:Publish API for the given topic.
topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.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

sns_action_property = ses_mixins.CfnMailManagerRuleSetPropsMixin.SnsActionProperty(
    action_failure_policy="actionFailurePolicy",
    encoding="encoding",
    payload_type="payloadType",
    role_arn="roleArn",
    topic_arn="topicArn"
)

Attributes

action_failure_policy

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the sns:Publish API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-actionfailurepolicy

encoding

The encoding to use for the email within the Amazon SNS notification.

The default value is UTF-8 . Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.

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

payload_type

The expected payload type within the Amazon SNS notification.

CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-payloadtype

role_arn

The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS.

This role must have access to the sns:Publish API for the given topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-snsaction.html#cfn-ses-mailmanagerruleset-snsaction-rolearn

topic_arn

The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.

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