AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::RDS::Model::CreateEventSubscriptionRequest Class Reference

#include <CreateEventSubscriptionRequest.h>

+ Inheritance diagram for Aws::RDS::Model::CreateEventSubscriptionRequest:

Public Member Functions

 CreateEventSubscriptionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetSubscriptionName () const
 
bool SubscriptionNameHasBeenSet () const
 
void SetSubscriptionName (const Aws::String &value)
 
void SetSubscriptionName (Aws::String &&value)
 
void SetSubscriptionName (const char *value)
 
CreateEventSubscriptionRequestWithSubscriptionName (const Aws::String &value)
 
CreateEventSubscriptionRequestWithSubscriptionName (Aws::String &&value)
 
CreateEventSubscriptionRequestWithSubscriptionName (const char *value)
 
const Aws::StringGetSnsTopicArn () const
 
bool SnsTopicArnHasBeenSet () const
 
void SetSnsTopicArn (const Aws::String &value)
 
void SetSnsTopicArn (Aws::String &&value)
 
void SetSnsTopicArn (const char *value)
 
CreateEventSubscriptionRequestWithSnsTopicArn (const Aws::String &value)
 
CreateEventSubscriptionRequestWithSnsTopicArn (Aws::String &&value)
 
CreateEventSubscriptionRequestWithSnsTopicArn (const char *value)
 
const Aws::StringGetSourceType () const
 
bool SourceTypeHasBeenSet () const
 
void SetSourceType (const Aws::String &value)
 
void SetSourceType (Aws::String &&value)
 
void SetSourceType (const char *value)
 
CreateEventSubscriptionRequestWithSourceType (const Aws::String &value)
 
CreateEventSubscriptionRequestWithSourceType (Aws::String &&value)
 
CreateEventSubscriptionRequestWithSourceType (const char *value)
 
const Aws::Vector< Aws::String > & GetEventCategories () const
 
bool EventCategoriesHasBeenSet () const
 
void SetEventCategories (const Aws::Vector< Aws::String > &value)
 
void SetEventCategories (Aws::Vector< Aws::String > &&value)
 
CreateEventSubscriptionRequestWithEventCategories (const Aws::Vector< Aws::String > &value)
 
CreateEventSubscriptionRequestWithEventCategories (Aws::Vector< Aws::String > &&value)
 
CreateEventSubscriptionRequestAddEventCategories (const Aws::String &value)
 
CreateEventSubscriptionRequestAddEventCategories (Aws::String &&value)
 
CreateEventSubscriptionRequestAddEventCategories (const char *value)
 
const Aws::Vector< Aws::String > & GetSourceIds () const
 
bool SourceIdsHasBeenSet () const
 
void SetSourceIds (const Aws::Vector< Aws::String > &value)
 
void SetSourceIds (Aws::Vector< Aws::String > &&value)
 
CreateEventSubscriptionRequestWithSourceIds (const Aws::Vector< Aws::String > &value)
 
CreateEventSubscriptionRequestWithSourceIds (Aws::Vector< Aws::String > &&value)
 
CreateEventSubscriptionRequestAddSourceIds (const Aws::String &value)
 
CreateEventSubscriptionRequestAddSourceIds (Aws::String &&value)
 
CreateEventSubscriptionRequestAddSourceIds (const char *value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
CreateEventSubscriptionRequestWithEnabled (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateEventSubscriptionRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateEventSubscriptionRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateEventSubscriptionRequestAddTags (const Tag &value)
 
CreateEventSubscriptionRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 26 of file CreateEventSubscriptionRequest.h.

Constructor & Destructor Documentation

◆ CreateEventSubscriptionRequest()

Aws::RDS::Model::CreateEventSubscriptionRequest::CreateEventSubscriptionRequest ( )

Member Function Documentation

◆ AddEventCategories() [1/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddEventCategories ( const Aws::String value)
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 307 of file CreateEventSubscriptionRequest.h.

◆ AddEventCategories() [2/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddEventCategories ( Aws::String &&  value)
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 317 of file CreateEventSubscriptionRequest.h.

◆ AddEventCategories() [3/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddEventCategories ( const char *  value)
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 327 of file CreateEventSubscriptionRequest.h.

◆ AddSourceIds() [1/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddSourceIds ( const Aws::String value)
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 468 of file CreateEventSubscriptionRequest.h.

◆ AddSourceIds() [2/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddSourceIds ( Aws::String &&  value)
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 488 of file CreateEventSubscriptionRequest.h.

◆ AddSourceIds() [3/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddSourceIds ( const char *  value)
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 508 of file CreateEventSubscriptionRequest.h.

◆ AddTags() [1/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddTags ( const Tag value)
inline

Definition at line 559 of file CreateEventSubscriptionRequest.h.

◆ AddTags() [2/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::AddTags ( Tag &&  value)
inline

Definition at line 562 of file CreateEventSubscriptionRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::CreateEventSubscriptionRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EnabledHasBeenSet()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::EnabledHasBeenSet ( ) const
inline

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Definition at line 523 of file CreateEventSubscriptionRequest.h.

◆ EventCategoriesHasBeenSet()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::EventCategoriesHasBeenSet ( ) const
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 257 of file CreateEventSubscriptionRequest.h.

◆ GetEnabled()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::GetEnabled ( ) const
inline

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Definition at line 516 of file CreateEventSubscriptionRequest.h.

◆ GetEventCategories()

const Aws::Vector<Aws::String>& Aws::RDS::Model::CreateEventSubscriptionRequest::GetEventCategories ( ) const
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 247 of file CreateEventSubscriptionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RDS::Model::CreateEventSubscriptionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateEventSubscriptionRequest.h.

◆ GetSnsTopicArn()

const Aws::String& Aws::RDS::Model::CreateEventSubscriptionRequest::GetSnsTopicArn ( ) const
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 98 of file CreateEventSubscriptionRequest.h.

◆ GetSourceIds()

const Aws::Vector<Aws::String>& Aws::RDS::Model::CreateEventSubscriptionRequest::GetSourceIds ( ) const
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 348 of file CreateEventSubscriptionRequest.h.

◆ GetSourceType()

const Aws::String& Aws::RDS::Model::CreateEventSubscriptionRequest::GetSourceType ( ) const
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 159 of file CreateEventSubscriptionRequest.h.

◆ GetSubscriptionName()

const Aws::String& Aws::RDS::Model::CreateEventSubscriptionRequest::GetSubscriptionName ( ) const
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 48 of file CreateEventSubscriptionRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::RDS::Model::CreateEventSubscriptionRequest::GetTags ( ) const
inline

Definition at line 541 of file CreateEventSubscriptionRequest.h.

◆ SerializePayload()

Aws::String Aws::RDS::Model::CreateEventSubscriptionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEnabled()

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetEnabled ( bool  value)
inline

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Definition at line 530 of file CreateEventSubscriptionRequest.h.

◆ SetEventCategories() [1/2]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetEventCategories ( const Aws::Vector< Aws::String > &  value)
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 267 of file CreateEventSubscriptionRequest.h.

◆ SetEventCategories() [2/2]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetEventCategories ( Aws::Vector< Aws::String > &&  value)
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 277 of file CreateEventSubscriptionRequest.h.

◆ SetSnsTopicArn() [1/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSnsTopicArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 112 of file CreateEventSubscriptionRequest.h.

◆ SetSnsTopicArn() [2/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSnsTopicArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 119 of file CreateEventSubscriptionRequest.h.

◆ SetSnsTopicArn() [3/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSnsTopicArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 126 of file CreateEventSubscriptionRequest.h.

◆ SetSourceIds() [1/2]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSourceIds ( const Aws::Vector< Aws::String > &  value)
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 388 of file CreateEventSubscriptionRequest.h.

◆ SetSourceIds() [2/2]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSourceIds ( Aws::Vector< Aws::String > &&  value)
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 408 of file CreateEventSubscriptionRequest.h.

◆ SetSourceType() [1/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSourceType ( const Aws::String value)
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 181 of file CreateEventSubscriptionRequest.h.

◆ SetSourceType() [2/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSourceType ( Aws::String &&  value)
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 192 of file CreateEventSubscriptionRequest.h.

◆ SetSourceType() [3/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSourceType ( const char *  value)
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 203 of file CreateEventSubscriptionRequest.h.

◆ SetSubscriptionName() [1/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSubscriptionName ( const Aws::String value)
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 60 of file CreateEventSubscriptionRequest.h.

◆ SetSubscriptionName() [2/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSubscriptionName ( Aws::String &&  value)
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 66 of file CreateEventSubscriptionRequest.h.

◆ SetSubscriptionName() [3/3]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetSubscriptionName ( const char *  value)
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 72 of file CreateEventSubscriptionRequest.h.

◆ SetTags() [1/2]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 547 of file CreateEventSubscriptionRequest.h.

◆ SetTags() [2/2]

void Aws::RDS::Model::CreateEventSubscriptionRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 550 of file CreateEventSubscriptionRequest.h.

◆ SnsTopicArnHasBeenSet()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::SnsTopicArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 105 of file CreateEventSubscriptionRequest.h.

◆ SourceIdsHasBeenSet()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::SourceIdsHasBeenSet ( ) const
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 368 of file CreateEventSubscriptionRequest.h.

◆ SourceTypeHasBeenSet()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::SourceTypeHasBeenSet ( ) const
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 170 of file CreateEventSubscriptionRequest.h.

◆ SubscriptionNameHasBeenSet()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::SubscriptionNameHasBeenSet ( ) const
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 54 of file CreateEventSubscriptionRequest.h.

◆ TagsHasBeenSet()

bool Aws::RDS::Model::CreateEventSubscriptionRequest::TagsHasBeenSet ( ) const
inline

Definition at line 544 of file CreateEventSubscriptionRequest.h.

◆ WithEnabled()

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithEnabled ( bool  value)
inline

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Definition at line 537 of file CreateEventSubscriptionRequest.h.

◆ WithEventCategories() [1/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithEventCategories ( const Aws::Vector< Aws::String > &  value)
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 287 of file CreateEventSubscriptionRequest.h.

◆ WithEventCategories() [2/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithEventCategories ( Aws::Vector< Aws::String > &&  value)
inline

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Definition at line 297 of file CreateEventSubscriptionRequest.h.

◆ WithSnsTopicArn() [1/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSnsTopicArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 133 of file CreateEventSubscriptionRequest.h.

◆ WithSnsTopicArn() [2/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSnsTopicArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 140 of file CreateEventSubscriptionRequest.h.

◆ WithSnsTopicArn() [3/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSnsTopicArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Definition at line 147 of file CreateEventSubscriptionRequest.h.

◆ WithSourceIds() [1/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSourceIds ( const Aws::Vector< Aws::String > &  value)
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 428 of file CreateEventSubscriptionRequest.h.

◆ WithSourceIds() [2/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSourceIds ( Aws::Vector< Aws::String > &&  value)
inline

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If a SourceIds value is supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Definition at line 448 of file CreateEventSubscriptionRequest.h.

◆ WithSourceType() [1/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSourceType ( const Aws::String value)
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 214 of file CreateEventSubscriptionRequest.h.

◆ WithSourceType() [2/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSourceType ( Aws::String &&  value)
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 225 of file CreateEventSubscriptionRequest.h.

◆ WithSourceType() [3/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSourceType ( const char *  value)
inline

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Definition at line 236 of file CreateEventSubscriptionRequest.h.

◆ WithSubscriptionName() [1/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSubscriptionName ( const Aws::String value)
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 78 of file CreateEventSubscriptionRequest.h.

◆ WithSubscriptionName() [2/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSubscriptionName ( Aws::String &&  value)
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 84 of file CreateEventSubscriptionRequest.h.

◆ WithSubscriptionName() [3/3]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithSubscriptionName ( const char *  value)
inline

The name of the subscription.

Constraints: The name must be less than 255 characters.

Definition at line 90 of file CreateEventSubscriptionRequest.h.

◆ WithTags() [1/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 553 of file CreateEventSubscriptionRequest.h.

◆ WithTags() [2/2]

CreateEventSubscriptionRequest& Aws::RDS::Model::CreateEventSubscriptionRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 556 of file CreateEventSubscriptionRequest.h.


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