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

#include <EventDestination.h>

Public Member Functions

 EventDestination ()
 
 EventDestination (const Aws::Utils::Xml::XmlNode &xmlNode)
 
EventDestinationoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) 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)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 46 of file EventDestination.h.

Constructor & Destructor Documentation

◆ EventDestination() [1/2]

Aws::SES::Model::EventDestination::EventDestination ( )

◆ EventDestination() [2/2]

Aws::SES::Model::EventDestination::EventDestination ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddMatchingEventTypes() [1/2]

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

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

Definition at line 180 of file EventDestination.h.

◆ AddMatchingEventTypes() [2/2]

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

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

Definition at line 185 of file EventDestination.h.

◆ CloudWatchDestinationHasBeenSet()

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

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

Definition at line 235 of file EventDestination.h.

◆ EnabledHasBeenSet()

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

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.

Definition at line 128 of file EventDestination.h.

◆ GetCloudWatchDestination()

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

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

Definition at line 229 of file EventDestination.h.

◆ GetEnabled()

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

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.

Definition at line 120 of file EventDestination.h.

◆ GetKinesisFirehoseDestination()

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

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

Definition at line 192 of file EventDestination.h.

◆ GetMatchingEventTypes()

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

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

Definition at line 150 of file EventDestination.h.

◆ GetName()

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

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.

Definition at line 62 of file EventDestination.h.

◆ GetSNSDestination()

const SNSDestination& Aws::SES::Model::EventDestination::GetSNSDestination ( ) const
inline

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

Definition at line 266 of file EventDestination.h.

◆ KinesisFirehoseDestinationHasBeenSet()

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

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

Definition at line 198 of file EventDestination.h.

◆ MatchingEventTypesHasBeenSet()

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

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

Definition at line 155 of file EventDestination.h.

◆ NameHasBeenSet()

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

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.

Definition at line 69 of file EventDestination.h.

◆ operator=()

EventDestination& Aws::SES::Model::EventDestination::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::SES::Model::EventDestination::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::SES::Model::EventDestination::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SetCloudWatchDestination() [1/2]

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

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

Definition at line 247 of file EventDestination.h.

◆ SetCloudWatchDestination() [2/2]

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

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

Definition at line 241 of file EventDestination.h.

◆ SetEnabled()

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

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.

Definition at line 136 of file EventDestination.h.

◆ SetKinesisFirehoseDestination() [1/2]

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

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

Definition at line 204 of file EventDestination.h.

◆ SetKinesisFirehoseDestination() [2/2]

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

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

Definition at line 210 of file EventDestination.h.

◆ SetMatchingEventTypes() [1/2]

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

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

Definition at line 165 of file EventDestination.h.

◆ SetMatchingEventTypes() [2/2]

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

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

Definition at line 160 of file EventDestination.h.

◆ SetName() [1/3]

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

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.

Definition at line 83 of file EventDestination.h.

◆ SetName() [2/3]

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

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.

Definition at line 76 of file EventDestination.h.

◆ SetName() [3/3]

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

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.

Definition at line 90 of file EventDestination.h.

◆ SetSNSDestination() [1/2]

void Aws::SES::Model::EventDestination::SetSNSDestination ( const SNSDestination value)
inline

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

Definition at line 278 of file EventDestination.h.

◆ SetSNSDestination() [2/2]

void Aws::SES::Model::EventDestination::SetSNSDestination ( SNSDestination &&  value)
inline

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

Definition at line 284 of file EventDestination.h.

◆ SNSDestinationHasBeenSet()

bool Aws::SES::Model::EventDestination::SNSDestinationHasBeenSet ( ) const
inline

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

Definition at line 272 of file EventDestination.h.

◆ WithCloudWatchDestination() [1/2]

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

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

Definition at line 259 of file EventDestination.h.

◆ WithCloudWatchDestination() [2/2]

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

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

Definition at line 253 of file EventDestination.h.

◆ WithEnabled()

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

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.

Definition at line 144 of file EventDestination.h.

◆ WithKinesisFirehoseDestination() [1/2]

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

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

Definition at line 216 of file EventDestination.h.

◆ WithKinesisFirehoseDestination() [2/2]

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

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

Definition at line 222 of file EventDestination.h.

◆ WithMatchingEventTypes() [1/2]

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

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

Definition at line 175 of file EventDestination.h.

◆ WithMatchingEventTypes() [2/2]

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

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

Definition at line 170 of file EventDestination.h.

◆ WithName() [1/3]

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

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.

Definition at line 104 of file EventDestination.h.

◆ WithName() [2/3]

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

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.

Definition at line 97 of file EventDestination.h.

◆ WithName() [3/3]

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

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.

Definition at line 111 of file EventDestination.h.

◆ WithSNSDestination() [1/2]

EventDestination& Aws::SES::Model::EventDestination::WithSNSDestination ( const SNSDestination value)
inline

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

Definition at line 290 of file EventDestination.h.

◆ WithSNSDestination() [2/2]

EventDestination& Aws::SES::Model::EventDestination::WithSNSDestination ( SNSDestination &&  value)
inline

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

Definition at line 296 of file EventDestination.h.


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