AWS::PinpointEmail::ConfigurationSetEventDestination EventDestination
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.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "CloudWatchDestination" :CloudWatchDestination, "Enabled" :Boolean, "KinesisFirehoseDestination" :KinesisFirehoseDestination, "MatchingEventTypes" :[ String, ... ], "PinpointDestination" :PinpointDestination, "SnsDestination" :SnsDestination}
YAML
CloudWatchDestination:CloudWatchDestinationEnabled:BooleanKinesisFirehoseDestination:KinesisFirehoseDestinationMatchingEventTypes:- StringPinpointDestination:PinpointDestinationSnsDestination:SnsDestination
Properties
CloudWatchDestination-
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.
Required: No
Type: CloudWatchDestination
Update requires: No interruption
Enabled-
If
true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in thisEventDestinationDefinition.If
false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.Required: No
Type: Boolean
Update requires: No interruption
KinesisFirehoseDestination-
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.
Required: No
Type: KinesisFirehoseDestination
Update requires: No interruption
MatchingEventTypes-
The types of events that Amazon Pinpoint sends to the specified event destinations. Acceptable values:
SEND,REJECT,BOUNCE,COMPLAINT,DELIVERY,OPEN,CLICK, andRENDERING_FAILURE.Required: Yes
Type: Array of String
Update requires: No interruption
PinpointDestination-
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.
Required: No
Type: PinpointDestination
Update requires: No interruption
SnsDestination-
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
Required: No
Type: SnsDestination
Update requires: No interruption