AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::SESV2::Model::EventDestination Class Reference

#include <EventDestination.h>

Public Member Functions

 EventDestination ()
 
 EventDestination (Aws::Utils::Json::JsonView jsonValue)
 
EventDestinationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
EventDestinationWithName (const Aws::String &value)
 
EventDestinationWithName (Aws::String &&value)
 
EventDestinationWithName (const char *value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
EventDestinationWithEnabled (bool value)
 
const Aws::Vector< EventType > & GetMatchingEventTypes () const
 
bool MatchingEventTypesHasBeenSet () const
 
void SetMatchingEventTypes (const Aws::Vector< EventType > &value)
 
void SetMatchingEventTypes (Aws::Vector< EventType > &&value)
 
EventDestinationWithMatchingEventTypes (const Aws::Vector< EventType > &value)
 
EventDestinationWithMatchingEventTypes (Aws::Vector< EventType > &&value)
 
EventDestinationAddMatchingEventTypes (const EventType &value)
 
EventDestinationAddMatchingEventTypes (EventType &&value)
 
const KinesisFirehoseDestinationGetKinesisFirehoseDestination () const
 
bool KinesisFirehoseDestinationHasBeenSet () const
 
void SetKinesisFirehoseDestination (const KinesisFirehoseDestination &value)
 
void SetKinesisFirehoseDestination (KinesisFirehoseDestination &&value)
 
EventDestinationWithKinesisFirehoseDestination (const KinesisFirehoseDestination &value)
 
EventDestinationWithKinesisFirehoseDestination (KinesisFirehoseDestination &&value)
 
const CloudWatchDestinationGetCloudWatchDestination () const
 
bool CloudWatchDestinationHasBeenSet () const
 
void SetCloudWatchDestination (const CloudWatchDestination &value)
 
void SetCloudWatchDestination (CloudWatchDestination &&value)
 
EventDestinationWithCloudWatchDestination (const CloudWatchDestination &value)
 
EventDestinationWithCloudWatchDestination (CloudWatchDestination &&value)
 
const SnsDestinationGetSnsDestination () const
 
bool SnsDestinationHasBeenSet () const
 
void SetSnsDestination (const SnsDestination &value)
 
void SetSnsDestination (SnsDestination &&value)
 
EventDestinationWithSnsDestination (const SnsDestination &value)
 
EventDestinationWithSnsDestination (SnsDestination &&value)
 
const PinpointDestinationGetPinpointDestination () const
 
bool PinpointDestinationHasBeenSet () const
 
void SetPinpointDestination (const PinpointDestination &value)
 
void SetPinpointDestination (PinpointDestination &&value)
 
EventDestinationWithPinpointDestination (const PinpointDestination &value)
 
EventDestinationWithPinpointDestination (PinpointDestination &&value)
 

Detailed Description

In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. 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 Reference

Definition at line 42 of file EventDestination.h.

Constructor & Destructor Documentation

◆ EventDestination() [1/2]

Aws::SESV2::Model::EventDestination::EventDestination ( )

◆ EventDestination() [2/2]

Aws::SESV2::Model::EventDestination::EventDestination ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddMatchingEventTypes() [1/2]

EventDestination& Aws::SESV2::Model::EventDestination::AddMatchingEventTypes ( const EventType value)
inline

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

Definition at line 169 of file EventDestination.h.

◆ AddMatchingEventTypes() [2/2]

EventDestination& Aws::SESV2::Model::EventDestination::AddMatchingEventTypes ( EventType &&  value)
inline

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

Definition at line 175 of file EventDestination.h.

◆ CloudWatchDestinationHasBeenSet()

bool Aws::SESV2::Model::EventDestination::CloudWatchDestinationHasBeenSet ( ) const
inline

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.

Definition at line 233 of file EventDestination.h.

◆ EnabledHasBeenSet()

bool Aws::SESV2::Model::EventDestination::EnabledHasBeenSet ( ) const
inline

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.

Definition at line 108 of file EventDestination.h.

◆ GetCloudWatchDestination()

const CloudWatchDestination& Aws::SESV2::Model::EventDestination::GetCloudWatchDestination ( ) const
inline

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.

Definition at line 226 of file EventDestination.h.

◆ GetEnabled()

bool Aws::SESV2::Model::EventDestination::GetEnabled ( ) const
inline

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.

Definition at line 99 of file EventDestination.h.

◆ GetKinesisFirehoseDestination()

const KinesisFirehoseDestination& Aws::SESV2::Model::EventDestination::GetKinesisFirehoseDestination ( ) const
inline

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.

Definition at line 183 of file EventDestination.h.

◆ GetMatchingEventTypes()

const Aws::Vector<EventType>& Aws::SESV2::Model::EventDestination::GetMatchingEventTypes ( ) const
inline

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

Definition at line 133 of file EventDestination.h.

◆ GetName()

const Aws::String& Aws::SESV2::Model::EventDestination::GetName ( ) const
inline

A name that identifies the event destination.

Definition at line 54 of file EventDestination.h.

◆ GetPinpointDestination()

const PinpointDestination& Aws::SESV2::Model::EventDestination::GetPinpointDestination ( ) const
inline

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.

Definition at line 309 of file EventDestination.h.

◆ GetSnsDestination()

const SnsDestination& Aws::SESV2::Model::EventDestination::GetSnsDestination ( ) const
inline

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

Definition at line 268 of file EventDestination.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SESV2::Model::EventDestination::Jsonize ( ) const

◆ KinesisFirehoseDestinationHasBeenSet()

bool Aws::SESV2::Model::EventDestination::KinesisFirehoseDestinationHasBeenSet ( ) const
inline

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.

Definition at line 190 of file EventDestination.h.

◆ MatchingEventTypesHasBeenSet()

bool Aws::SESV2::Model::EventDestination::MatchingEventTypesHasBeenSet ( ) const
inline

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

Definition at line 139 of file EventDestination.h.

◆ NameHasBeenSet()

bool Aws::SESV2::Model::EventDestination::NameHasBeenSet ( ) const
inline

A name that identifies the event destination.

Definition at line 59 of file EventDestination.h.

◆ operator=()

EventDestination& Aws::SESV2::Model::EventDestination::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PinpointDestinationHasBeenSet()

bool Aws::SESV2::Model::EventDestination::PinpointDestinationHasBeenSet ( ) const
inline

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.

Definition at line 319 of file EventDestination.h.

◆ SetCloudWatchDestination() [1/2]

void Aws::SESV2::Model::EventDestination::SetCloudWatchDestination ( CloudWatchDestination &&  value)
inline

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.

Definition at line 247 of file EventDestination.h.

◆ SetCloudWatchDestination() [2/2]

void Aws::SESV2::Model::EventDestination::SetCloudWatchDestination ( const CloudWatchDestination value)
inline

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.

Definition at line 240 of file EventDestination.h.

◆ SetEnabled()

void Aws::SESV2::Model::EventDestination::SetEnabled ( bool  value)
inline

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.

Definition at line 117 of file EventDestination.h.

◆ SetKinesisFirehoseDestination() [1/2]

void Aws::SESV2::Model::EventDestination::SetKinesisFirehoseDestination ( const KinesisFirehoseDestination value)
inline

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.

Definition at line 197 of file EventDestination.h.

◆ SetKinesisFirehoseDestination() [2/2]

void Aws::SESV2::Model::EventDestination::SetKinesisFirehoseDestination ( KinesisFirehoseDestination &&  value)
inline

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.

Definition at line 204 of file EventDestination.h.

◆ SetMatchingEventTypes() [1/2]

void Aws::SESV2::Model::EventDestination::SetMatchingEventTypes ( Aws::Vector< EventType > &&  value)
inline

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

Definition at line 151 of file EventDestination.h.

◆ SetMatchingEventTypes() [2/2]

void Aws::SESV2::Model::EventDestination::SetMatchingEventTypes ( const Aws::Vector< EventType > &  value)
inline

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

Definition at line 145 of file EventDestination.h.

◆ SetName() [1/3]

void Aws::SESV2::Model::EventDestination::SetName ( Aws::String &&  value)
inline

A name that identifies the event destination.

Definition at line 69 of file EventDestination.h.

◆ SetName() [2/3]

void Aws::SESV2::Model::EventDestination::SetName ( const Aws::String value)
inline

A name that identifies the event destination.

Definition at line 64 of file EventDestination.h.

◆ SetName() [3/3]

void Aws::SESV2::Model::EventDestination::SetName ( const char *  value)
inline

A name that identifies the event destination.

Definition at line 74 of file EventDestination.h.

◆ SetPinpointDestination() [1/2]

void Aws::SESV2::Model::EventDestination::SetPinpointDestination ( const PinpointDestination value)
inline

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.

Definition at line 329 of file EventDestination.h.

◆ SetPinpointDestination() [2/2]

void Aws::SESV2::Model::EventDestination::SetPinpointDestination ( PinpointDestination &&  value)
inline

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.

Definition at line 339 of file EventDestination.h.

◆ SetSnsDestination() [1/2]

void Aws::SESV2::Model::EventDestination::SetSnsDestination ( const SnsDestination value)
inline

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

Definition at line 280 of file EventDestination.h.

◆ SetSnsDestination() [2/2]

void Aws::SESV2::Model::EventDestination::SetSnsDestination ( SnsDestination &&  value)
inline

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

Definition at line 286 of file EventDestination.h.

◆ SnsDestinationHasBeenSet()

bool Aws::SESV2::Model::EventDestination::SnsDestinationHasBeenSet ( ) const
inline

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

Definition at line 274 of file EventDestination.h.

◆ WithCloudWatchDestination() [1/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithCloudWatchDestination ( CloudWatchDestination &&  value)
inline

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.

Definition at line 261 of file EventDestination.h.

◆ WithCloudWatchDestination() [2/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithCloudWatchDestination ( const CloudWatchDestination value)
inline

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.

Definition at line 254 of file EventDestination.h.

◆ WithEnabled()

EventDestination& Aws::SESV2::Model::EventDestination::WithEnabled ( bool  value)
inline

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.

Definition at line 126 of file EventDestination.h.

◆ WithKinesisFirehoseDestination() [1/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithKinesisFirehoseDestination ( const KinesisFirehoseDestination value)
inline

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.

Definition at line 211 of file EventDestination.h.

◆ WithKinesisFirehoseDestination() [2/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithKinesisFirehoseDestination ( KinesisFirehoseDestination &&  value)
inline

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.

Definition at line 218 of file EventDestination.h.

◆ WithMatchingEventTypes() [1/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithMatchingEventTypes ( Aws::Vector< EventType > &&  value)
inline

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

Definition at line 163 of file EventDestination.h.

◆ WithMatchingEventTypes() [2/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithMatchingEventTypes ( const Aws::Vector< EventType > &  value)
inline

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

Definition at line 157 of file EventDestination.h.

◆ WithName() [1/3]

EventDestination& Aws::SESV2::Model::EventDestination::WithName ( Aws::String &&  value)
inline

A name that identifies the event destination.

Definition at line 84 of file EventDestination.h.

◆ WithName() [2/3]

EventDestination& Aws::SESV2::Model::EventDestination::WithName ( const Aws::String value)
inline

A name that identifies the event destination.

Definition at line 79 of file EventDestination.h.

◆ WithName() [3/3]

EventDestination& Aws::SESV2::Model::EventDestination::WithName ( const char *  value)
inline

A name that identifies the event destination.

Definition at line 89 of file EventDestination.h.

◆ WithPinpointDestination() [1/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithPinpointDestination ( const PinpointDestination value)
inline

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.

Definition at line 349 of file EventDestination.h.

◆ WithPinpointDestination() [2/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithPinpointDestination ( PinpointDestination &&  value)
inline

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.

Definition at line 359 of file EventDestination.h.

◆ WithSnsDestination() [1/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithSnsDestination ( const SnsDestination value)
inline

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

Definition at line 292 of file EventDestination.h.

◆ WithSnsDestination() [2/2]

EventDestination& Aws::SESV2::Model::EventDestination::WithSnsDestination ( SnsDestination &&  value)
inline

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

Definition at line 298 of file EventDestination.h.


The documentation for this class was generated from the following file: