class Aws::SES::Types::EventDestination
Contains information about the event destination that the specified email sending events will be published to.
<note markdown=“1”> When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
</note>
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the [Amazon SES
Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
@note When making an API call, you may pass EventDestination
data as a hash: { name: "EventDestinationName", # required enabled: false, matching_event_types: ["send"], # required, accepts send, reject, bounce, complaint, delivery, open, click, renderingFailure 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: "messageTag", # required, accepts messageTag, emailHeader, linkTag default_dimension_value: "DefaultDimensionValue", # required }, ], }, sns_destination: { topic_arn: "AmazonResourceName", # required }, }
@!attribute [rw] name
The name of the event destination. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (\_), or dashes (-). * Contain less than 64 characters. @return [String]
@!attribute [rw] enabled
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to `true` to enable publishing to this destination; set to `false` to prevent publishing to this destination. The default value is `false`. @return [Boolean]
@!attribute [rw] matching_event_types
The type of email sending events to publish to the event destination. @return [Array<String>]
@!attribute [rw] kinesis_firehose_destination
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination. @return [Types::KinesisFirehoseDestination]
@!attribute [rw] cloud_watch_destination
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination. @return [Types::CloudWatchDestination]
@!attribute [rw] sns_destination
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination. @return [Types::SNSDestination]
@see docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/EventDestination AWS API Documentation
Constants
- SENSITIVE