CfnConfigurationSetEventDestinationPropsMixin

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

Bases: Mixin

Create an event destination.

In Amazon Pinpoint, 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-pinpointemail-configurationseteventdestination.html
CloudformationResource:: AWS::PinpointEmail::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_pinpointemail import mixins as pinpointemail_mixins

cfn_configuration_set_event_destination_props_mixin = pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin(pinpointemail_mixins.CfnConfigurationSetEventDestinationMixinProps(
    configuration_set_name="configurationSetName",
    event_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.EventDestinationProperty(
        cloud_watch_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.CloudWatchDestinationProperty(
            dimension_configurations=[pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty(
                default_dimension_value="defaultDimensionValue",
                dimension_name="dimensionName",
                dimension_value_source="dimensionValueSource"
            )]
        ),
        enabled=False,
        kinesis_firehose_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.KinesisFirehoseDestinationProperty(
            delivery_stream_arn="deliveryStreamArn",
            iam_role_arn="iamRoleArn"
        ),
        matching_event_types=["matchingEventTypes"],
        pinpoint_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.PinpointDestinationProperty(
            application_arn="applicationArn"
        ),
        sns_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.SnsDestinationProperty(
            topic_arn="topicArn"
        )
    ),
    event_destination_name="eventDestinationName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::PinpointEmail::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', 'eventDestinationName']

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-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

cloud_watch_destination_property = pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.CloudWatchDestinationProperty(
    dimension_configurations=[pinpointemail_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-pinpointemail-configurationseteventdestination-cloudwatchdestination.html#cfn-pinpointemail-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations

DimensionConfigurationProperty

class CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty(*, default_dimension_value=None, dimension_name=None, dimension_value_source=None)

Bases: object

An array of objects that define the dimensions 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: - 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_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 Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. Acceptable values: MESSAGE_TAG , EMAIL_HEADER , and LINK_TAG . If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail API, choose MESSAGE_TAG . If you want Amazon Pinpoint to use your own email headers, choose EMAIL_HEADER . If you want Amazon Pinpoint to use tags that are specified in your links, choose LINK_TAG .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

dimension_configuration_property = pinpointemail_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:

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-pinpointemail-configurationseteventdestination-dimensionconfiguration.html#cfn-pinpointemail-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-pinpointemail-configurationseteventdestination-dimensionconfiguration.html#cfn-pinpointemail-configurationseteventdestination-dimensionconfiguration-dimensionname

dimension_value_source

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.

Acceptable values: MESSAGE_TAG , EMAIL_HEADER , and LINK_TAG .

If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail API, choose MESSAGE_TAG . If you want Amazon Pinpoint to use your own email headers, choose EMAIL_HEADER . If you want Amazon Pinpoint to use tags that are specified in your links, choose LINK_TAG .

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

EventDestinationProperty

class CfnConfigurationSetEventDestinationPropsMixin.EventDestinationProperty(*, cloud_watch_destination=None, enabled=None, kinesis_firehose_destination=None, matching_event_types=None, pinpoint_destination=None, sns_destination=None)

Bases: object

In Amazon Pinpoint, 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.

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.
kinesis_firehose_destination (Union[IResolvable, KinesisFirehoseDestinationProperty, Dict[str, Any], None]) – 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.
matching_event_types (Optional[Sequence[str]]) – The types of events that Amazon Pinpoint sends to the specified event destinations. Acceptable values: SEND , REJECT , BOUNCE , COMPLAINT , DELIVERY , OPEN , CLICK , and RENDERING_FAILURE .
pinpoint_destination (Union[IResolvable, PinpointDestinationProperty, Dict[str, Any], None]) – An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
sns_destination (Union[IResolvable, SnsDestinationProperty, Dict[str, Any], None]) – An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

event_destination_property = pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.EventDestinationProperty(
    cloud_watch_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.CloudWatchDestinationProperty(
        dimension_configurations=[pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty(
            default_dimension_value="defaultDimensionValue",
            dimension_name="dimensionName",
            dimension_value_source="dimensionValueSource"
        )]
    ),
    enabled=False,
    kinesis_firehose_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.KinesisFirehoseDestinationProperty(
        delivery_stream_arn="deliveryStreamArn",
        iam_role_arn="iamRoleArn"
    ),
    matching_event_types=["matchingEventTypes"],
    pinpoint_destination=pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.PinpointDestinationProperty(
        application_arn="applicationArn"
    ),
    sns_destination=pinpointemail_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-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-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-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-enabled

kinesis_firehose_destination

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.

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

matching_event_types

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

Acceptable values: SEND , REJECT , BOUNCE , COMPLAINT , DELIVERY , OPEN , CLICK , and RENDERING_FAILURE .

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

pinpoint_destination

An object that defines a Amazon Pinpoint destination for email events.

You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestination-pinpointdestination

sns_destination

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

You can use Amazon SNS to send notification when certain email events occur.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-eventdestination.html#cfn-pinpointemail-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 Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
iam_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

kinesis_firehose_destination_property = pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.KinesisFirehoseDestinationProperty(
    delivery_stream_arn="deliveryStreamArn",
    iam_role_arn="iamRoleArn"
)

Attributes

delivery_stream_arn

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

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

iam_role_arn

The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

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

PinpointDestinationProperty

class CfnConfigurationSetEventDestinationPropsMixin.PinpointDestinationProperty(*, application_arn=None)

Bases: object

An object that defines a Amazon Pinpoint destination for email events.

You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

Parameters:: application_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-pinpointdestination.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_pinpointemail import mixins as pinpointemail_mixins

pinpoint_destination_property = pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.PinpointDestinationProperty(
    application_arn="applicationArn"
)

Attributes

application_arn

The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationseteventdestination-pinpointdestination.html#cfn-pinpointemail-configurationseteventdestination-pinpointdestination-applicationarn

SnsDestinationProperty

class CfnConfigurationSetEventDestinationPropsMixin.SnsDestinationProperty(*, topic_arn=None)

Bases: object

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

You can use Amazon SNS to send notification when certain email events occur.

Parameters:: topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-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_pinpointemail import mixins as pinpointemail_mixins

sns_destination_property = pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.SnsDestinationProperty(
    topic_arn="topicArn"
)

Attributes

topic_arn

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to.

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

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