Class: Aws::SES::Types::EventDestination
- Inherits:
-
Struct
- Object
- Struct
- Aws::SES::Types::EventDestination
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ses/types.rb
Overview
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
},
}
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
Instance Attribute Summary collapse
-
#cloud_watch_destination ⇒ Types::CloudWatchDestination
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
-
#enabled ⇒ Boolean
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.
-
#kinesis_firehose_destination ⇒ Types::KinesisFirehoseDestination
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
-
#matching_event_types ⇒ Array<String>
The type of email sending events to publish to the event destination.
-
#name ⇒ String
The name of the event destination.
-
#sns_destination ⇒ Types::SNSDestination
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Instance Attribute Details
#cloud_watch_destination ⇒ Types::CloudWatchDestination
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
1696 1697 1698 1699 1700 1701 1702 1703 1704 |
# File 'lib/aws-sdk-ses/types.rb', line 1696 class EventDestination < Struct.new( :name, :enabled, :matching_event_types, :kinesis_firehose_destination, :cloud_watch_destination, :sns_destination) include Aws::Structure end |
#enabled ⇒ Boolean
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`.
1696 1697 1698 1699 1700 1701 1702 1703 1704 |
# File 'lib/aws-sdk-ses/types.rb', line 1696 class EventDestination < Struct.new( :name, :enabled, :matching_event_types, :kinesis_firehose_destination, :cloud_watch_destination, :sns_destination) include Aws::Structure end |
#kinesis_firehose_destination ⇒ Types::KinesisFirehoseDestination
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
1696 1697 1698 1699 1700 1701 1702 1703 1704 |
# File 'lib/aws-sdk-ses/types.rb', line 1696 class EventDestination < Struct.new( :name, :enabled, :matching_event_types, :kinesis_firehose_destination, :cloud_watch_destination, :sns_destination) include Aws::Structure end |
#matching_event_types ⇒ Array<String>
The type of email sending events to publish to the event destination.
1696 1697 1698 1699 1700 1701 1702 1703 1704 |
# File 'lib/aws-sdk-ses/types.rb', line 1696 class EventDestination < Struct.new( :name, :enabled, :matching_event_types, :kinesis_firehose_destination, :cloud_watch_destination, :sns_destination) include Aws::Structure end |
#name ⇒ String
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.
1696 1697 1698 1699 1700 1701 1702 1703 1704 |
# File 'lib/aws-sdk-ses/types.rb', line 1696 class EventDestination < Struct.new( :name, :enabled, :matching_event_types, :kinesis_firehose_destination, :cloud_watch_destination, :sns_destination) include Aws::Structure end |
#sns_destination ⇒ Types::SNSDestination
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
1696 1697 1698 1699 1700 1701 1702 1703 1704 |
# File 'lib/aws-sdk-ses/types.rb', line 1696 class EventDestination < Struct.new( :name, :enabled, :matching_event_types, :kinesis_firehose_destination, :cloud_watch_destination, :sns_destination) include Aws::Structure end |