Class: Aws::SESV2::Types::EventDestinationDefinition

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

Overview

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, DELIVERY_DELAY, SUBSCRIPTION
  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",
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_destinationTypes::CloudWatchDestination

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.



2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2395

class EventDestinationDefinition < Struct.new(
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination,
  :pinpoint_destination)
  SENSITIVE = []
  include Aws::Structure
end

#enabledBoolean

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.

Returns:

  • (Boolean)


2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2395

class EventDestinationDefinition < Struct.new(
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination,
  :pinpoint_destination)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_firehose_destinationTypes::KinesisFirehoseDestination

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.



2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2395

class EventDestinationDefinition < Struct.new(
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination,
  :pinpoint_destination)
  SENSITIVE = []
  include Aws::Structure
end

#matching_event_typesArray<String>

An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.

Returns:

  • (Array<String>)


2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2395

class EventDestinationDefinition < Struct.new(
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination,
  :pinpoint_destination)
  SENSITIVE = []
  include Aws::Structure
end

#pinpoint_destinationTypes::PinpointDestination

An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.



2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2395

class EventDestinationDefinition < Struct.new(
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination,
  :pinpoint_destination)
  SENSITIVE = []
  include Aws::Structure
end

#sns_destinationTypes::SnsDestination

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.



2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2395

class EventDestinationDefinition < Struct.new(
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination,
  :pinpoint_destination)
  SENSITIVE = []
  include Aws::Structure
end