CfnConfigurationSetEventDestinationPropsMixin

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

Bases: Mixin

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
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_configuration_set_event_destination_props_mixin = ses_mixins.CfnConfigurationSetEventDestinationPropsMixin(ses_mixins.CfnConfigurationSetEventDestinationMixinProps(
    configuration_set_name="configurationSetName",
    event_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.EventDestinationProperty(
        cloud_watch_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.CloudWatchDestinationProperty(
            dimension_configurations=[ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty(
                default_dimension_value="defaultDimensionValue",
                dimension_name="dimensionName",
                dimension_value_source="dimensionValueSource"
            )]
        ),
        enabled=False,
        event_bridge_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.EventBridgeDestinationProperty(
            event_bus_arn="eventBusArn"
        ),
        kinesis_firehose_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.KinesisFirehoseDestinationProperty(
            delivery_stream_arn="deliveryStreamArn",
            iam_role_arn="iamRoleArn"
        ),
        matching_event_types=["matchingEventTypes"],
        name="name",
        sns_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.SnsDestinationProperty(
            topic_arn="topicArn"
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['configurationSetName', 'eventDestination']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

CloudWatchDestinationProperty

class CfnConfigurationSetEventDestinationPropsMixin.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.mixins_preview.aws_ses import mixins as ses_mixins

cloud_watch_destination_property = ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.CloudWatchDestinationProperty(
    dimension_configurations=[ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.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 CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty(*, default_dimension_value=None, dimension_name=None, dimension_value_source=None)

Bases: object

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

Parameters:

default_dimension_value (Optional[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 (Optional[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 (Optional[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.mixins_preview.aws_ses import mixins as ses_mixins

dimension_configuration_property = ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.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 CfnConfigurationSetEventDestinationPropsMixin.EventBridgeDestinationProperty(*, event_bus_arn=None)

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 (Optional[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.mixins_preview.aws_ses import mixins as ses_mixins

event_bridge_destination_property = ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.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 CfnConfigurationSetEventDestinationPropsMixin.EventDestinationProperty(*, cloud_watch_destination=None, enabled=None, event_bridge_destination=None, kinesis_firehose_destination=None, matching_event_types=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:

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.
matching_event_types (Optional[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 `SendEmail <https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html>`_ or `SendBulkEmail <https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.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 .
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.mixins_preview.aws_ses import mixins as ses_mixins

event_destination_property = ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.EventDestinationProperty(
    cloud_watch_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.CloudWatchDestinationProperty(
        dimension_configurations=[ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty(
            default_dimension_value="defaultDimensionValue",
            dimension_name="dimensionName",
            dimension_value_source="dimensionValueSource"
        )]
    ),
    enabled=False,
    event_bridge_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.EventBridgeDestinationProperty(
        event_bus_arn="eventBusArn"
    ),
    kinesis_firehose_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.KinesisFirehoseDestinationProperty(
        delivery_stream_arn="deliveryStreamArn",
        iam_role_arn="iamRoleArn"
    ),
    matching_event_types=["matchingEventTypes"],
    name="name",
    sns_destination=ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.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 `SendEmail <https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html>`_ or `SendBulkEmail <https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.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 CfnConfigurationSetEventDestinationPropsMixin.KinesisFirehoseDestinationProperty(*, delivery_stream_arn=None, iam_role_arn=None)

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 (Optional[str]) – The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
iam_role_arn (Optional[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.mixins_preview.aws_ses import mixins as ses_mixins

kinesis_firehose_destination_property = ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.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 CfnConfigurationSetEventDestinationPropsMixin.SnsDestinationProperty(*, topic_arn=None)

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 (Optional[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.mixins_preview.aws_ses import mixins as ses_mixins

sns_destination_property = ses_mixins.CfnConfigurationSetEventDestinationPropsMixin.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