You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SES::Types::EventDestination

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

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
  },
}

Contains information about the event destination that the specified email sending events will be published to.

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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_destinationTypes::CloudWatchDestination

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.



1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1558

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  include Aws::Structure
end

#enabledBoolean

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.

Returns:

  • (Boolean)


1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1558

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  include Aws::Structure
end

#kinesis_firehose_destinationTypes::KinesisFirehoseDestination

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.



1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1558

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  include Aws::Structure
end

#matching_event_typesArray<String>

The type of email sending events to publish to the event destination.

Returns:

  • (Array<String>)


1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1558

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  include Aws::Structure
end

#nameString

The name of the event destination. The name must:

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

  • Contain less than 64 characters.

Returns:

  • (String)


1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1558

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  include Aws::Structure
end

#sns_destinationTypes::SNSDestination

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.



1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1558

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  include Aws::Structure
end