Class: Aws::PinpointEmail::Types::EventDestination

Inherits:

Struct

• Object
• Struct
• Aws::PinpointEmail::Types::EventDestination

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointemail/types.rb

Overview

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cloud_watch_destination ⇒ Types::CloudWatchDestination

  An object that defines an Amazon CloudWatch destination for email events.

• #enabled ⇒ Boolean

  If ‘true`, the event destination is enabled.

• #kinesis_firehose_destination ⇒ Types::KinesisFirehoseDestination

  An object that defines an Amazon Kinesis Data Firehose destination for email events.

• #matching_event_types ⇒ Array<String>

  The types of events that Amazon Pinpoint sends to the specified event destinations.

• #name ⇒ String

  A name that identifies the event destination.

• #pinpoint_destination ⇒ Types::PinpointDestination

  An object that defines a Amazon Pinpoint destination for email events.

• #sns_destination ⇒ Types::SnsDestination

  An object that defines an Amazon SNS destination for email events.

Instance Attribute Details

#cloud_watch_destination ⇒ Types::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.

Returns:

• (Types::CloudWatchDestination)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1016

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

#enabled ⇒ Boolean

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)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1016

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

#kinesis_firehose_destination ⇒ Types::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.

Returns:

• (Types::KinesisFirehoseDestination)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1016

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

#matching_event_types ⇒ Array<String>

The types of events that Amazon Pinpoint sends to the specified event destinations.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1016

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

#name ⇒ String

A name that identifies the event destination.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1016

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

#pinpoint_destination ⇒ Types::PinpointDestination

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

Returns:

• (Types::PinpointDestination)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1016

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

#sns_destination ⇒ Types::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.

Returns:

• (Types::SnsDestination)

# File 'lib/aws-sdk-pinpointemail/types.rb', line 1016

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