class Aws::PinpointEmail::Types::EventDestinationDefinition
An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
@note When making an API call, you may pass EventDestinationDefinition
data as a hash: { enabled: false, matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE kinesis_firehose_destination: { iam_role_arn: "AmazonResourceName", # required delivery_stream_arn: "AmazonResourceName", # required }, cloud_watch_destination: { dimension_configurations: [ # required { dimension_name: "DimensionName", # required dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG default_dimension_value: "DefaultDimensionValue", # required }, ], }, sns_destination: { topic_arn: "AmazonResourceName", # required }, pinpoint_destination: { application_arn: "AmazonResourceName", }, }
@!attribute [rw] 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. @return [Boolean]
@!attribute [rw] matching_event_types
An array that specifies which events Amazon Pinpoint should send to the destinations in this `EventDestinationDefinition`. @return [Array<String>]
@!attribute [rw] 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. @return [Types::KinesisFirehoseDestination]
@!attribute [rw] 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. @return [Types::CloudWatchDestination]
@!attribute [rw] 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. @return [Types::SnsDestination]
@!attribute [rw] 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. @return [Types::PinpointDestination]
@see docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/EventDestinationDefinition AWS API Documentation
Constants
- SENSITIVE