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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EventDestination as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (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. 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) —

    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.

Returns:

  • (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.

Returns:

  • (Array<String>) —

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

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

Returns:

  • (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.

Returns:

  • (Types::SNSDestination) —

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