CfnConfigurationSetEventDestination

class aws_cdk.aws_ses.CfnConfigurationSetEventDestination(scope, id, *, configuration_set_name, event_destination)

Bases: CfnResource

Specifies a configuration set event destination.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

A single configuration set can include more than one event destination.

See:

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

CloudformationResource:

AWS::SES::ConfigurationSetEventDestination

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

cfn_configuration_set_event_destination = ses.CfnConfigurationSetEventDestination(self, "MyCfnConfigurationSetEventDestination",
    configuration_set_name="configurationSetName",
    event_destination=ses.CfnConfigurationSetEventDestination.EventDestinationProperty(
        matching_event_types=["matchingEventTypes"],

        # the properties below are optional
        cloud_watch_destination=ses.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(
            dimension_configurations=[ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty(
                default_dimension_value="defaultDimensionValue",
                dimension_name="dimensionName",
                dimension_value_source="dimensionValueSource"
            )]
        ),
        enabled=False,
        event_bridge_destination=ses.CfnConfigurationSetEventDestination.EventBridgeDestinationProperty(
            event_bus_arn="eventBusArn"
        ),
        kinesis_firehose_destination=ses.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty(
            delivery_stream_arn="deliveryStreamArn",
            iam_role_arn="iamRoleArn"
        ),
        name="name",
        sns_destination=ses.CfnConfigurationSetEventDestination.SnsDestinationProperty(
            topic_arn="topicArn"
        )
    )
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

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

  • configuration_set_name (str) – The name of the configuration set that contains the event destination.

  • event_destination (Union[IResolvable, EventDestinationProperty, Dict[str, Any]]) – An object that defines the event destination.

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::ConfigurationSetEventDestination'
attr_id

Id

Type:

cloudformationAttribute

cfn_options

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

cfn_resource_type

AWS resource type.

configuration_set_name

The name of the configuration set that contains the event destination.

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.

event_destination

An object that defines the event destination.

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

stack

The stack in which this element is defined.

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

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.

CloudWatchDestinationProperty

class CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(*, dimension_configurations=None)

Bases: object

An object that defines an Amazon CloudWatch destination for email events.

You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

Parameters:

dimension_configurations (Union[IResolvable, Sequence[Union[IResolvable, DimensionConfigurationProperty, Dict[str, Any]]], None]) – An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

See:

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

cloud_watch_destination_property = ses.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(
    dimension_configurations=[ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty(
        default_dimension_value="defaultDimensionValue",
        dimension_name="dimensionName",
        dimension_value_source="dimensionValueSource"
    )]
)

Attributes

dimension_configurations

An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html#cfn-ses-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations

DimensionConfigurationProperty

class CfnConfigurationSetEventDestination.DimensionConfigurationProperty(*, default_dimension_value, dimension_name, dimension_value_source)

Bases: object

An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.

Parameters:
  • default_dimension_value (str) – The default value of the dimension that is published to Amazon CloudWatch if you don’t provide the value of the dimension when you send an email. This value has to meet the following criteria: - Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.). - It can contain no more than 256 characters.

  • dimension_name (str) – The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). - It can contain no more than 256 characters.

  • dimension_value_source (str) – The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag . To use your own email headers, choose emailHeader . To use link tags, choose linkTag .

See:

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

dimension_configuration_property = ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty(
    default_dimension_value="defaultDimensionValue",
    dimension_name="dimensionName",
    dimension_value_source="dimensionValueSource"
)

Attributes

default_dimension_value

The default value of the dimension that is published to Amazon CloudWatch if you don’t provide the value of the dimension when you send an email.

This value has to meet the following criteria:

  • Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).

  • It can contain no more than 256 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-defaultdimensionvalue

dimension_name

The name of an Amazon CloudWatch dimension associated with an email sending metric.

The name has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionname

dimension_value_source

The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch.

To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag . To use your own email headers, choose emailHeader . To use link tags, choose linkTag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionvaluesource

EventBridgeDestinationProperty

class CfnConfigurationSetEventDestination.EventBridgeDestinationProperty(*, event_bus_arn)

Bases: object

An object that defines an Amazon EventBridge destination for email events.

You can use Amazon EventBridge to send notifications when certain email events occur.

Parameters:

event_bus_arn (str) – The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported.

See:

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

event_bridge_destination_property = ses.CfnConfigurationSetEventDestination.EventBridgeDestinationProperty(
    event_bus_arn="eventBusArn"
)

Attributes

event_bus_arn

The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to.

Only the default bus is supported.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventbridgedestination.html#cfn-ses-configurationseteventdestination-eventbridgedestination-eventbusarn

EventDestinationProperty

class CfnConfigurationSetEventDestination.EventDestinationProperty(*, matching_event_types, cloud_watch_destination=None, enabled=None, event_bridge_destination=None, kinesis_firehose_destination=None, name=None, sns_destination=None)

Bases: object

In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays.

Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Parameters:
  • matching_event_types (Sequence[str]) – The types of events that Amazon SES sends to the specified event destinations. - SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.) - REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server. - BOUNCE - ( Hard bounce ) The recipient’s mail server permanently rejected the email. ( Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.) - COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam. - DELIVERY - SES successfully delivered the email to the recipient’s mail server. - OPEN - The recipient received the message and opened it in their email client. - CLICK - The recipient clicked one or more links in the email. - RENDERING_FAILURE - The email wasn’t sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the `SendTemplatedEmail <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html>`_ or `SendBulkTemplatedEmail <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html>`_ API operations.) - DELIVERY_DELAY - The email couldn’t be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient’s inbox is full, or when the receiving email server experiences a transient issue. - SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management .

  • cloud_watch_destination (Union[IResolvable, CloudWatchDestinationProperty, Dict[str, Any], None]) – An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

  • enabled (Union[bool, IResolvable, None]) – If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition . If false , the event destination is disabled. When the event destination is disabled, events aren’t sent to the specified destinations.

  • event_bridge_destination (Union[IResolvable, EventBridgeDestinationProperty, Dict[str, Any], None]) – An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.

  • kinesis_firehose_destination (Union[IResolvable, KinesisFirehoseDestinationProperty, Dict[str, Any], None]) – An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

  • name (Optional[str]) – The name of the event destination. The name must meet the following requirements:. - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer.

  • sns_destination (Union[IResolvable, SnsDestinationProperty, Dict[str, Any], None]) – An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

See:

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

event_destination_property = ses.CfnConfigurationSetEventDestination.EventDestinationProperty(
    matching_event_types=["matchingEventTypes"],

    # the properties below are optional
    cloud_watch_destination=ses.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(
        dimension_configurations=[ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty(
            default_dimension_value="defaultDimensionValue",
            dimension_name="dimensionName",
            dimension_value_source="dimensionValueSource"
        )]
    ),
    enabled=False,
    event_bridge_destination=ses.CfnConfigurationSetEventDestination.EventBridgeDestinationProperty(
        event_bus_arn="eventBusArn"
    ),
    kinesis_firehose_destination=ses.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty(
        delivery_stream_arn="deliveryStreamArn",
        iam_role_arn="iamRoleArn"
    ),
    name="name",
    sns_destination=ses.CfnConfigurationSetEventDestination.SnsDestinationProperty(
        topic_arn="topicArn"
    )
)

Attributes

cloud_watch_destination

An object that defines an Amazon CloudWatch destination for email events.

You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-cloudwatchdestination

enabled

If true , the event destination is enabled.

When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .

If false , the event destination is disabled. When the event destination is disabled, events aren’t sent to the specified destinations.

See:

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

event_bridge_destination

An object that defines an Amazon EventBridge destination for email events.

You can use Amazon EventBridge to send notifications when certain email events occur.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-eventbridgedestination

kinesis_firehose_destination

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-kinesisfirehosedestination

matching_event_types

The types of events that Amazon SES sends to the specified event destinations.

  • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

  • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

  • BOUNCE - ( Hard bounce ) The recipient’s mail server permanently rejected the email. ( Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

  • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

  • DELIVERY - SES successfully delivered the email to the recipient’s mail server.

  • OPEN - The recipient received the message and opened it in their email client.

  • CLICK - The recipient clicked one or more links in the email.

  • RENDERING_FAILURE - The email wasn’t sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the `SendTemplatedEmail <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html>`_ or `SendBulkTemplatedEmail <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html>`_ API operations.)

  • DELIVERY_DELAY - The email couldn’t be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient’s inbox is full, or when the receiving email server experiences a transient issue.

  • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-matchingeventtypes

name

.

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain 64 characters or fewer.

See:

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

Type:

The name of the event destination. The name must meet the following requirements

sns_destination

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-snsdestination

KinesisFirehoseDestinationProperty

class CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty(*, delivery_stream_arn, iam_role_arn)

Bases: object

An object that defines an Amazon Kinesis Data Firehose destination for email events.

You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

Parameters:
  • delivery_stream_arn (str) – The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

  • iam_role_arn (str) – The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.

See:

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

kinesis_firehose_destination_property = ses.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty(
    delivery_stream_arn="deliveryStreamArn",
    iam_role_arn="iamRoleArn"
)

Attributes

delivery_stream_arn

The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-deliverystreamarn

iam_role_arn

The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-iamrolearn

SnsDestinationProperty

class CfnConfigurationSetEventDestination.SnsDestinationProperty(*, topic_arn)

Bases: object

Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .

Parameters:

topic_arn (str) – The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by using the ListTopics Amazon SNS operation. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .

See:

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

sns_destination_property = ses.CfnConfigurationSetEventDestination.SnsDestinationProperty(
    topic_arn="topicArn"
)

Attributes

topic_arn

The ARN of the Amazon SNS topic for email sending events.

You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .

See:

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