CfnConfigurationSetEventDestination

class aws_cdk.aws_pinpointemail.CfnConfigurationSetEventDestination(scope, id, *, configuration_set_name, event_destination_name, event_destination=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::PinpointEmail::ConfigurationSetEventDestination.

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.

CloudformationResource

AWS::PinpointEmail::ConfigurationSetEventDestination

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_configuration_set_event_destination = pinpointemail.CfnConfigurationSetEventDestination(self, "MyCfnConfigurationSetEventDestination",
    configuration_set_name="configurationSetName",
    event_destination_name="eventDestinationName",

    # the properties below are optional
    event_destination=pinpointemail.CfnConfigurationSetEventDestination.EventDestinationProperty(
        matching_event_types=["matchingEventTypes"],

        # the properties below are optional
        cloud_watch_destination=pinpointemail.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(
            dimension_configurations=[pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty(
                default_dimension_value="defaultDimensionValue",
                dimension_name="dimensionName",
                dimension_value_source="dimensionValueSource"
            )]
        ),
        enabled=False,
        kinesis_firehose_destination=pinpointemail.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty(
            delivery_stream_arn="deliveryStreamArn",
            iam_role_arn="iamRoleArn"
        ),
        pinpoint_destination=pinpointemail.CfnConfigurationSetEventDestination.PinpointDestinationProperty(
            application_arn="applicationArn"
        ),
        sns_destination=pinpointemail.CfnConfigurationSetEventDestination.SnsDestinationProperty(
            topic_arn="topicArn"
        )
    )
)

Create a new AWS::PinpointEmail::ConfigurationSetEventDestination.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

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

  • event_destination_name (str) – The name of the event destination that you want to modify.

  • event_destination (Union[IResolvable, EventDestinationProperty, None]) – 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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

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

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

Return type

None

get_att(attribute_name)

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.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

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

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::PinpointEmail::ConfigurationSetEventDestination'
cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

configuration_set_name

The name of the configuration set that contains the event destination that you want to modify.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationseteventdestination.html#cfn-pinpointemail-configurationseteventdestination-configurationsetname

Return type

str

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.

Return type

List[str]

event_destination

An object that defines the event destination.

Link

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

Return type

Union[IResolvable, EventDestinationProperty, None]

event_destination_name

The name of the event destination that you want to modify.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationseteventdestination.html#cfn-pinpointemail-configurationseteventdestination-eventdestinationname

Return type

str

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

Return type

str

Returns

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

node

The construct tree node associated with this construct.

Return type

ConstructNode

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

Return type

str

stack

The stack in which this element is defined.

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

Return type

Stack

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

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

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]], None]) – An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

Link

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.
import aws_cdk.aws_pinpointemail as pinpointemail

cloud_watch_destination_property = pinpointemail.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(
    dimension_configurations=[pinpointemail.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.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, DimensionConfigurationProperty]], None]

DimensionConfigurationProperty

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

Bases: object

An array of objects that define the dimensions 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: - 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 (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 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 .

Link

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.
import aws_cdk.aws_pinpointemail as pinpointemail

dimension_configuration_property = pinpointemail.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:

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

  • It can contain no more than 256 characters.

Link

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

Return type

str

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.

Link

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

Return type

str

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 .

Link

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

Return type

str

EventDestinationProperty

class CfnConfigurationSetEventDestination.EventDestinationProperty(*, matching_event_types, cloud_watch_destination=None, enabled=None, kinesis_firehose_destination=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
  • matching_event_types (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 .

  • cloud_watch_destination (Union[IResolvable, CloudWatchDestinationProperty, 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, 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.

  • pinpoint_destination (Union[IResolvable, PinpointDestinationProperty, 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, 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.

Link

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.
import aws_cdk.aws_pinpointemail as pinpointemail

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

    # the properties below are optional
    cloud_watch_destination=pinpointemail.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(
        dimension_configurations=[pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty(
            default_dimension_value="defaultDimensionValue",
            dimension_name="dimensionName",
            dimension_value_source="dimensionValueSource"
        )]
    ),
    enabled=False,
    kinesis_firehose_destination=pinpointemail.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty(
        delivery_stream_arn="deliveryStreamArn",
        iam_role_arn="iamRoleArn"
    ),
    pinpoint_destination=pinpointemail.CfnConfigurationSetEventDestination.PinpointDestinationProperty(
        application_arn="applicationArn"
    ),
    sns_destination=pinpointemail.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.

Link

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

Return type

Union[IResolvable, CloudWatchDestinationProperty, None]

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.

Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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

Return type

Union[IResolvable, KinesisFirehoseDestinationProperty, None]

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 .

Link

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

Return type

List[str]

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.

Link

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

Return type

Union[IResolvable, PinpointDestinationProperty, None]

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.

Link

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

Return type

Union[IResolvable, SnsDestinationProperty, None]

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 Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

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

Link

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.
import aws_cdk.aws_pinpointemail as pinpointemail

kinesis_firehose_destination_property = pinpointemail.CfnConfigurationSetEventDestination.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.

Link

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

Return type

str

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.

Link

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

Return type

str

PinpointDestinationProperty

class CfnConfigurationSetEventDestination.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.

Link

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.
import aws_cdk.aws_pinpointemail as pinpointemail

pinpoint_destination_property = pinpointemail.CfnConfigurationSetEventDestination.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.

Link

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

Return type

Optional[str]

SnsDestinationProperty

class CfnConfigurationSetEventDestination.SnsDestinationProperty(*, topic_arn)

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

Link

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.
import aws_cdk.aws_pinpointemail as pinpointemail

sns_destination_property = pinpointemail.CfnConfigurationSetEventDestination.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 .

Link

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

Return type

str