CfnMailManagerRuleSet

class aws_cdk.aws_ses.CfnMailManagerRuleSet(scope, id, *, rules, rule_set_name=None, tags=None)

Bases: CfnResource

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

ExampleMetadata:

fixture=_generated

Example:

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

# drop: Any

cfn_mail_manager_rule_set = ses.CfnMailManagerRuleSet(self, "MyCfnMailManagerRuleSet",
    rules=[ses.CfnMailManagerRuleSet.RuleProperty(
        actions=[ses.CfnMailManagerRuleSet.RuleActionProperty(
            add_header=ses.CfnMailManagerRuleSet.AddHeaderActionProperty(
                header_name="headerName",
                header_value="headerValue"
            ),
            archive=ses.CfnMailManagerRuleSet.ArchiveActionProperty(
                target_archive="targetArchive",

                # the properties below are optional
                action_failure_policy="actionFailurePolicy"
            ),
            deliver_to_mailbox=ses.CfnMailManagerRuleSet.DeliverToMailboxActionProperty(
                mailbox_arn="mailboxArn",
                role_arn="roleArn",

                # the properties below are optional
                action_failure_policy="actionFailurePolicy"
            ),
            deliver_to_qBusiness=ses.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty(
                application_id="applicationId",
                index_id="indexId",
                role_arn="roleArn",

                # the properties below are optional
                action_failure_policy="actionFailurePolicy"
            ),
            drop=drop,
            relay=ses.CfnMailManagerRuleSet.RelayActionProperty(
                relay="relay",

                # the properties below are optional
                action_failure_policy="actionFailurePolicy",
                mail_from="mailFrom"
            ),
            replace_recipient=ses.CfnMailManagerRuleSet.ReplaceRecipientActionProperty(
                replace_with=["replaceWith"]
            ),
            send=ses.CfnMailManagerRuleSet.SendActionProperty(
                role_arn="roleArn",

                # the properties below are optional
                action_failure_policy="actionFailurePolicy"
            ),
            write_to_s3=ses.CfnMailManagerRuleSet.S3ActionProperty(
                role_arn="roleArn",
                s3_bucket="s3Bucket",

                # the properties below are optional
                action_failure_policy="actionFailurePolicy",
                s3_prefix="s3Prefix",
                s3_sse_kms_key_id="s3SseKmsKeyId"
            )
        )],

        # the properties below are optional
        conditions=[ses.CfnMailManagerRuleSet.RuleConditionProperty(
            boolean_expression=ses.CfnMailManagerRuleSet.RuleBooleanExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator"
            ),
            dmarc_expression=ses.CfnMailManagerRuleSet.RuleDmarcExpressionProperty(
                operator="operator",
                values=["values"]
            ),
            ip_expression=ses.CfnMailManagerRuleSet.RuleIpExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleIpToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            ),
            number_expression=ses.CfnMailManagerRuleSet.RuleNumberExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleNumberToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                value=123
            ),
            string_expression=ses.CfnMailManagerRuleSet.RuleStringExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleStringToEvaluateProperty(
                    attribute="attribute",
                    mime_header_attribute="mimeHeaderAttribute"
                ),
                operator="operator",
                values=["values"]
            ),
            verdict_expression=ses.CfnMailManagerRuleSet.RuleVerdictExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty(
                    analysis=ses.CfnMailManagerRuleSet.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            )
        )],
        name="name",
        unless=[ses.CfnMailManagerRuleSet.RuleConditionProperty(
            boolean_expression=ses.CfnMailManagerRuleSet.RuleBooleanExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator"
            ),
            dmarc_expression=ses.CfnMailManagerRuleSet.RuleDmarcExpressionProperty(
                operator="operator",
                values=["values"]
            ),
            ip_expression=ses.CfnMailManagerRuleSet.RuleIpExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleIpToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            ),
            number_expression=ses.CfnMailManagerRuleSet.RuleNumberExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleNumberToEvaluateProperty(
                    attribute="attribute"
                ),
                operator="operator",
                value=123
            ),
            string_expression=ses.CfnMailManagerRuleSet.RuleStringExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleStringToEvaluateProperty(
                    attribute="attribute",
                    mime_header_attribute="mimeHeaderAttribute"
                ),
                operator="operator",
                values=["values"]
            ),
            verdict_expression=ses.CfnMailManagerRuleSet.RuleVerdictExpressionProperty(
                evaluate=ses.CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty(
                    analysis=ses.CfnMailManagerRuleSet.AnalysisProperty(
                        analyzer="analyzer",
                        result_field="resultField"
                    ),
                    attribute="attribute"
                ),
                operator="operator",
                values=["values"]
            )
        )]
    )],

    # the properties below are optional
    rule_set_name="ruleSetName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]]]) – Conditional rules that are evaluated for determining actions on email.

  • rule_set_name (Optional[str]) – A user-friendly name for the rule set.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

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.

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"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
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::MailManagerRuleSet'
attr_rule_set_arn

The Amazon Resource Name (ARN) of the rule set resource.

CloudformationAttribute:

RuleSetArn

attr_rule_set_id

The identifier of the rule set.

CloudformationAttribute:

RuleSetId

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

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

cfn_resource_type

AWS resource type.

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.

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).

Returns:

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

node

The tree node.

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 }).

rule_set_name

A user-friendly name for the rule set.

rules

Conditional rules that are evaluated for determining actions on email.

stack

The stack in which this element is defined.

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

tags

The tags used to organize, track, or control access for the resource.

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

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

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

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AddHeaderActionProperty

class CfnMailManagerRuleSet.AddHeaderActionProperty(*, header_name, header_value)

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 (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 (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 import aws_ses as ses

add_header_action_property = ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.AnalysisProperty(*, analyzer, result_field)

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 (str) – The Amazon Resource Name (ARN) of an Add On.

  • result_field (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 import aws_ses as ses

analysis_property = ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.ArchiveActionProperty(*, target_archive, action_failure_policy=None)

Bases: object

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

Parameters:

  • target_archive (str) – The identifier of the archive to send the email to.

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

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 import aws_ses as ses

archive_action_property = ses.CfnMailManagerRuleSet.ArchiveActionProperty(
    target_archive="targetArchive",

    # the properties below are optional
    action_failure_policy="actionFailurePolicy"
)

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 CfnMailManagerRuleSet.DeliverToMailboxActionProperty(*, mailbox_arn, role_arn, action_failure_policy=None)

Bases: object

This action to delivers an email to a mailbox.

Parameters:

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

  • role_arn (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.

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

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 import aws_ses as ses

deliver_to_mailbox_action_property = ses.CfnMailManagerRuleSet.DeliverToMailboxActionProperty(
    mailbox_arn="mailboxArn",
    role_arn="roleArn",

    # the properties below are optional
    action_failure_policy="actionFailurePolicy"
)

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 CfnMailManagerRuleSet.DeliverToQBusinessActionProperty(*, application_id, index_id, role_arn, action_failure_policy=None)

Bases: object

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

Parameters:

  • application_id (str) – The unique identifier of the Amazon Q Business application instance where the email content will be delivered.

  • index_id (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 (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.

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

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 import aws_ses as ses

deliver_to_qBusiness_action_property = ses.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty(
    application_id="applicationId",
    index_id="indexId",
    role_arn="roleArn",

    # the properties below are optional
    action_failure_policy="actionFailurePolicy"
)

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 CfnMailManagerRuleSet.RelayActionProperty(*, relay, action_failure_policy=None, mail_from=None)

Bases: object

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

Parameters:

  • relay (str) – The identifier of the relay resource to be used when relaying an email.

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

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 import aws_ses as ses

relay_action_property = ses.CfnMailManagerRuleSet.RelayActionProperty(
    relay="relay",

    # the properties below are optional
    action_failure_policy="actionFailurePolicy",
    mail_from="mailFrom"
)

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 CfnMailManagerRuleSet.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 import aws_ses as ses

replace_recipient_action_property = ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.RuleActionProperty(*, add_header=None, archive=None, deliver_to_mailbox=None, deliver_to_q_business=None, drop=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:
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 import aws_ses as ses

# drop: Any

rule_action_property = ses.CfnMailManagerRuleSet.RuleActionProperty(
    add_header=ses.CfnMailManagerRuleSet.AddHeaderActionProperty(
        header_name="headerName",
        header_value="headerValue"
    ),
    archive=ses.CfnMailManagerRuleSet.ArchiveActionProperty(
        target_archive="targetArchive",

        # the properties below are optional
        action_failure_policy="actionFailurePolicy"
    ),
    deliver_to_mailbox=ses.CfnMailManagerRuleSet.DeliverToMailboxActionProperty(
        mailbox_arn="mailboxArn",
        role_arn="roleArn",

        # the properties below are optional
        action_failure_policy="actionFailurePolicy"
    ),
    deliver_to_qBusiness=ses.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty(
        application_id="applicationId",
        index_id="indexId",
        role_arn="roleArn",

        # the properties below are optional
        action_failure_policy="actionFailurePolicy"
    ),
    drop=drop,
    relay=ses.CfnMailManagerRuleSet.RelayActionProperty(
        relay="relay",

        # the properties below are optional
        action_failure_policy="actionFailurePolicy",
        mail_from="mailFrom"
    ),
    replace_recipient=ses.CfnMailManagerRuleSet.ReplaceRecipientActionProperty(
        replace_with=["replaceWith"]
    ),
    send=ses.CfnMailManagerRuleSet.SendActionProperty(
        role_arn="roleArn",

        # the properties below are optional
        action_failure_policy="actionFailurePolicy"
    ),
    write_to_s3=ses.CfnMailManagerRuleSet.S3ActionProperty(
        role_arn="roleArn",
        s3_bucket="s3Bucket",

        # the properties below are optional
        action_failure_policy="actionFailurePolicy",
        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

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 CfnMailManagerRuleSet.RuleBooleanExpressionProperty(*, evaluate, operator)

Bases: object

A boolean expression to be used in a rule condition.

Parameters:

  • evaluate (Union[IResolvable, RuleBooleanToEvaluateProperty, Dict[str, Any]]) – The operand on which to perform a boolean condition operation.

  • operator (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 import aws_ses as ses

rule_boolean_expression_property = ses.CfnMailManagerRuleSet.RuleBooleanExpressionProperty(
    evaluate=ses.CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(
        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 CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(*, attribute)

Bases: object

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

Parameters:

attribute (str) – 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

ExampleMetadata:

fixture=_generated

Example:

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

rule_boolean_to_evaluate_property = ses.CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(
    attribute="attribute"
)

Attributes

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

RuleConditionProperty

class CfnMailManagerRuleSet.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:
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 import aws_ses as ses

rule_condition_property = ses.CfnMailManagerRuleSet.RuleConditionProperty(
    boolean_expression=ses.CfnMailManagerRuleSet.RuleBooleanExpressionProperty(
        evaluate=ses.CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(
            attribute="attribute"
        ),
        operator="operator"
    ),
    dmarc_expression=ses.CfnMailManagerRuleSet.RuleDmarcExpressionProperty(
        operator="operator",
        values=["values"]
    ),
    ip_expression=ses.CfnMailManagerRuleSet.RuleIpExpressionProperty(
        evaluate=ses.CfnMailManagerRuleSet.RuleIpToEvaluateProperty(
            attribute="attribute"
        ),
        operator="operator",
        values=["values"]
    ),
    number_expression=ses.CfnMailManagerRuleSet.RuleNumberExpressionProperty(
        evaluate=ses.CfnMailManagerRuleSet.RuleNumberToEvaluateProperty(
            attribute="attribute"
        ),
        operator="operator",
        value=123
    ),
    string_expression=ses.CfnMailManagerRuleSet.RuleStringExpressionProperty(
        evaluate=ses.CfnMailManagerRuleSet.RuleStringToEvaluateProperty(
            attribute="attribute",
            mime_header_attribute="mimeHeaderAttribute"
        ),
        operator="operator",
        values=["values"]
    ),
    verdict_expression=ses.CfnMailManagerRuleSet.RuleVerdictExpressionProperty(
        evaluate=ses.CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty(
            analysis=ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.RuleDmarcExpressionProperty(*, operator, values)

Bases: object

A DMARC policy expression.

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

Parameters:

  • operator (str) – The operator to apply to the DMARC policy of the incoming email.

  • values (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 import aws_ses as ses

rule_dmarc_expression_property = ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.RuleIpExpressionProperty(*, evaluate, operator, values)

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]]) – The IP address to evaluate in this condition.

  • operator (str) – The operator to evaluate the IP address.

  • values (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 import aws_ses as ses

rule_ip_expression_property = ses.CfnMailManagerRuleSet.RuleIpExpressionProperty(
    evaluate=ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.RuleIpToEvaluateProperty(*, attribute)

Bases: object

The IP address to evaluate for this condition.

Parameters:

attribute (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 import aws_ses as ses

rule_ip_to_evaluate_property = ses.CfnMailManagerRuleSet.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

RuleNumberExpressionProperty

class CfnMailManagerRuleSet.RuleNumberExpressionProperty(*, evaluate, operator, value)

Bases: object

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

Parameters:

  • evaluate (Union[IResolvable, RuleNumberToEvaluateProperty, Dict[str, Any]]) – The number to evaluate in a numeric condition expression.

  • operator (str) – The operator for a numeric condition expression.

  • value (Union[int, float]) – 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 import aws_ses as ses

rule_number_expression_property = ses.CfnMailManagerRuleSet.RuleNumberExpressionProperty(
    evaluate=ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.RuleNumberToEvaluateProperty(*, attribute)

Bases: object

The number to evaluate in a numeric condition expression.

Parameters:

attribute (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 import aws_ses as ses

rule_number_to_evaluate_property = ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.RuleProperty(*, actions, 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]]]]) – 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 import aws_ses as ses

# drop: Any

rule_property = ses.CfnMailManagerRuleSet.RuleProperty(
    actions=[ses.CfnMailManagerRuleSet.RuleActionProperty(
        add_header=ses.CfnMailManagerRuleSet.AddHeaderActionProperty(
            header_name="headerName",
            header_value="headerValue"
        ),
        archive=ses.CfnMailManagerRuleSet.ArchiveActionProperty(
            target_archive="targetArchive",

            # the properties below are optional
            action_failure_policy="actionFailurePolicy"
        ),
        deliver_to_mailbox=ses.CfnMailManagerRuleSet.DeliverToMailboxActionProperty(
            mailbox_arn="mailboxArn",
            role_arn="roleArn",

            # the properties below are optional
            action_failure_policy="actionFailurePolicy"
        ),
        deliver_to_qBusiness=ses.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty(
            application_id="applicationId",
            index_id="indexId",
            role_arn="roleArn",

            # the properties below are optional
            action_failure_policy="actionFailurePolicy"
        ),
        drop=drop,
        relay=ses.CfnMailManagerRuleSet.RelayActionProperty(
            relay="relay",

            # the properties below are optional
            action_failure_policy="actionFailurePolicy",
            mail_from="mailFrom"
        ),
        replace_recipient=ses.CfnMailManagerRuleSet.ReplaceRecipientActionProperty(
            replace_with=["replaceWith"]
        ),
        send=ses.CfnMailManagerRuleSet.SendActionProperty(
            role_arn="roleArn",

            # the properties below are optional
            action_failure_policy="actionFailurePolicy"
        ),
        write_to_s3=ses.CfnMailManagerRuleSet.S3ActionProperty(
            role_arn="roleArn",
            s3_bucket="s3Bucket",

            # the properties below are optional
            action_failure_policy="actionFailurePolicy",
            s3_prefix="s3Prefix",
            s3_sse_kms_key_id="s3SseKmsKeyId"
        )
    )],

    # the properties below are optional
    conditions=[ses.CfnMailManagerRuleSet.RuleConditionProperty(
        boolean_expression=ses.CfnMailManagerRuleSet.RuleBooleanExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator"
        ),
        dmarc_expression=ses.CfnMailManagerRuleSet.RuleDmarcExpressionProperty(
            operator="operator",
            values=["values"]
        ),
        ip_expression=ses.CfnMailManagerRuleSet.RuleIpExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleIpToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            values=["values"]
        ),
        number_expression=ses.CfnMailManagerRuleSet.RuleNumberExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleNumberToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            value=123
        ),
        string_expression=ses.CfnMailManagerRuleSet.RuleStringExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleStringToEvaluateProperty(
                attribute="attribute",
                mime_header_attribute="mimeHeaderAttribute"
            ),
            operator="operator",
            values=["values"]
        ),
        verdict_expression=ses.CfnMailManagerRuleSet.RuleVerdictExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty(
                analysis=ses.CfnMailManagerRuleSet.AnalysisProperty(
                    analyzer="analyzer",
                    result_field="resultField"
                ),
                attribute="attribute"
            ),
            operator="operator",
            values=["values"]
        )
    )],
    name="name",
    unless=[ses.CfnMailManagerRuleSet.RuleConditionProperty(
        boolean_expression=ses.CfnMailManagerRuleSet.RuleBooleanExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator"
        ),
        dmarc_expression=ses.CfnMailManagerRuleSet.RuleDmarcExpressionProperty(
            operator="operator",
            values=["values"]
        ),
        ip_expression=ses.CfnMailManagerRuleSet.RuleIpExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleIpToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            values=["values"]
        ),
        number_expression=ses.CfnMailManagerRuleSet.RuleNumberExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleNumberToEvaluateProperty(
                attribute="attribute"
            ),
            operator="operator",
            value=123
        ),
        string_expression=ses.CfnMailManagerRuleSet.RuleStringExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleStringToEvaluateProperty(
                attribute="attribute",
                mime_header_attribute="mimeHeaderAttribute"
            ),
            operator="operator",
            values=["values"]
        ),
        verdict_expression=ses.CfnMailManagerRuleSet.RuleVerdictExpressionProperty(
            evaluate=ses.CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty(
                analysis=ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.RuleStringExpressionProperty(*, evaluate, operator, values)

Bases: object

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

Parameters:

  • evaluate (Union[IResolvable, RuleStringToEvaluateProperty, Dict[str, Any]]) – The string to evaluate in a string condition expression.

  • operator (str) – The matching operator for a string condition expression.

  • values (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 import aws_ses as ses

rule_string_expression_property = ses.CfnMailManagerRuleSet.RuleStringExpressionProperty(
    evaluate=ses.CfnMailManagerRuleSet.RuleStringToEvaluateProperty(
        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 CfnMailManagerRuleSet.RuleStringToEvaluateProperty(*, 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:

  • 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 import aws_ses as ses

rule_string_to_evaluate_property = ses.CfnMailManagerRuleSet.RuleStringToEvaluateProperty(
    attribute="attribute",
    mime_header_attribute="mimeHeaderAttribute"
)

Attributes

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 CfnMailManagerRuleSet.RuleVerdictExpressionProperty(*, evaluate, operator, values)

Bases: object

A verdict expression is evaluated against verdicts of the email.

Parameters:

  • evaluate (Union[IResolvable, RuleVerdictToEvaluateProperty, Dict[str, Any]]) – The verdict to evaluate in a verdict condition expression.

  • operator (str) – The matching operator for a verdict condition expression.

  • values (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 import aws_ses as ses

rule_verdict_expression_property = ses.CfnMailManagerRuleSet.RuleVerdictExpressionProperty(
    evaluate=ses.CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty(
        analysis=ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.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 import aws_ses as ses

rule_verdict_to_evaluate_property = ses.CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty(
    analysis=ses.CfnMailManagerRuleSet.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 CfnMailManagerRuleSet.S3ActionProperty(*, role_arn, s3_bucket, action_failure_policy=None, s3_prefix=None, s3_sse_kms_key_id=None)

Bases: object

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

Parameters:

  • role_arn (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 (str) – The bucket name of the S3 bucket to write to.

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

  • 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 import aws_ses as ses

s3_action_property = ses.CfnMailManagerRuleSet.S3ActionProperty(
    role_arn="roleArn",
    s3_bucket="s3Bucket",

    # the properties below are optional
    action_failure_policy="actionFailurePolicy",
    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 CfnMailManagerRuleSet.SendActionProperty(*, role_arn, action_failure_policy=None)

Bases: object

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

Parameters:

  • role_arn (str) – The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.

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

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 import aws_ses as ses

send_action_property = ses.CfnMailManagerRuleSet.SendActionProperty(
    role_arn="roleArn",

    # the properties below are optional
    action_failure_policy="actionFailurePolicy"
)

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