AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::DocDB::Model::FailoverDBClusterRequest Class Reference

#include <FailoverDBClusterRequest.h>

+ Inheritance diagram for Aws::DocDB::Model::FailoverDBClusterRequest:

Public Member Functions

 FailoverDBClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
FailoverDBClusterRequestWithDBClusterIdentifier (const Aws::String &value)
 
FailoverDBClusterRequestWithDBClusterIdentifier (Aws::String &&value)
 
FailoverDBClusterRequestWithDBClusterIdentifier (const char *value)
 
const Aws::StringGetTargetDBInstanceIdentifier () const
 
bool TargetDBInstanceIdentifierHasBeenSet () const
 
void SetTargetDBInstanceIdentifier (const Aws::String &value)
 
void SetTargetDBInstanceIdentifier (Aws::String &&value)
 
void SetTargetDBInstanceIdentifier (const char *value)
 
FailoverDBClusterRequestWithTargetDBInstanceIdentifier (const Aws::String &value)
 
FailoverDBClusterRequestWithTargetDBInstanceIdentifier (Aws::String &&value)
 
FailoverDBClusterRequestWithTargetDBInstanceIdentifier (const char *value)
 
- Public Member Functions inherited from Aws::DocDB::DocDBRequest
virtual ~DocDBRequest ()
 
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::DocDB::DocDBRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input to FailoverDBCluster.

See Also:

AWS API Reference

Definition at line 25 of file FailoverDBClusterRequest.h.

Constructor & Destructor Documentation

◆ FailoverDBClusterRequest()

Aws::DocDB::Model::FailoverDBClusterRequest::FailoverDBClusterRequest ( )

Member Function Documentation

◆ DBClusterIdentifierHasBeenSet()

bool Aws::DocDB::Model::FailoverDBClusterRequest::DBClusterIdentifierHasBeenSet ( ) const
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 55 of file FailoverDBClusterRequest.h.

◆ DumpBodyToUrl()

void Aws::DocDB::Model::FailoverDBClusterRequest::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.

◆ GetDBClusterIdentifier()

const Aws::String& Aws::DocDB::Model::FailoverDBClusterRequest::GetDBClusterIdentifier ( ) const
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 48 of file FailoverDBClusterRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DocDB::Model::FailoverDBClusterRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file FailoverDBClusterRequest.h.

◆ GetTargetDBInstanceIdentifier()

const Aws::String& Aws::DocDB::Model::FailoverDBClusterRequest::GetTargetDBInstanceIdentifier ( ) const
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 105 of file FailoverDBClusterRequest.h.

◆ SerializePayload()

Aws::String Aws::DocDB::Model::FailoverDBClusterRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBClusterIdentifier() [1/3]

void Aws::DocDB::Model::FailoverDBClusterRequest::SetDBClusterIdentifier ( const Aws::String value)
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 62 of file FailoverDBClusterRequest.h.

◆ SetDBClusterIdentifier() [2/3]

void Aws::DocDB::Model::FailoverDBClusterRequest::SetDBClusterIdentifier ( Aws::String &&  value)
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 69 of file FailoverDBClusterRequest.h.

◆ SetDBClusterIdentifier() [3/3]

void Aws::DocDB::Model::FailoverDBClusterRequest::SetDBClusterIdentifier ( const char *  value)
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 76 of file FailoverDBClusterRequest.h.

◆ SetTargetDBInstanceIdentifier() [1/3]

void Aws::DocDB::Model::FailoverDBClusterRequest::SetTargetDBInstanceIdentifier ( const Aws::String value)
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 119 of file FailoverDBClusterRequest.h.

◆ SetTargetDBInstanceIdentifier() [2/3]

void Aws::DocDB::Model::FailoverDBClusterRequest::SetTargetDBInstanceIdentifier ( Aws::String &&  value)
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 126 of file FailoverDBClusterRequest.h.

◆ SetTargetDBInstanceIdentifier() [3/3]

void Aws::DocDB::Model::FailoverDBClusterRequest::SetTargetDBInstanceIdentifier ( const char *  value)
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 133 of file FailoverDBClusterRequest.h.

◆ TargetDBInstanceIdentifierHasBeenSet()

bool Aws::DocDB::Model::FailoverDBClusterRequest::TargetDBInstanceIdentifierHasBeenSet ( ) const
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 112 of file FailoverDBClusterRequest.h.

◆ WithDBClusterIdentifier() [1/3]

FailoverDBClusterRequest& Aws::DocDB::Model::FailoverDBClusterRequest::WithDBClusterIdentifier ( const Aws::String value)
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 83 of file FailoverDBClusterRequest.h.

◆ WithDBClusterIdentifier() [2/3]

FailoverDBClusterRequest& Aws::DocDB::Model::FailoverDBClusterRequest::WithDBClusterIdentifier ( Aws::String &&  value)
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 90 of file FailoverDBClusterRequest.h.

◆ WithDBClusterIdentifier() [3/3]

FailoverDBClusterRequest& Aws::DocDB::Model::FailoverDBClusterRequest::WithDBClusterIdentifier ( const char *  value)
inline

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 97 of file FailoverDBClusterRequest.h.

◆ WithTargetDBInstanceIdentifier() [1/3]

FailoverDBClusterRequest& Aws::DocDB::Model::FailoverDBClusterRequest::WithTargetDBInstanceIdentifier ( const Aws::String value)
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 140 of file FailoverDBClusterRequest.h.

◆ WithTargetDBInstanceIdentifier() [2/3]

FailoverDBClusterRequest& Aws::DocDB::Model::FailoverDBClusterRequest::WithTargetDBInstanceIdentifier ( Aws::String &&  value)
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 147 of file FailoverDBClusterRequest.h.

◆ WithTargetDBInstanceIdentifier() [3/3]

FailoverDBClusterRequest& Aws::DocDB::Model::FailoverDBClusterRequest::WithTargetDBInstanceIdentifier ( const char *  value)
inline

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Definition at line 154 of file FailoverDBClusterRequest.h.


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