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

#include <PromoteReadReplicaRequest.h>

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

Public Member Functions

 PromoteReadReplicaRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBInstanceIdentifier () const
 
bool DBInstanceIdentifierHasBeenSet () const
 
void SetDBInstanceIdentifier (const Aws::String &value)
 
void SetDBInstanceIdentifier (Aws::String &&value)
 
void SetDBInstanceIdentifier (const char *value)
 
PromoteReadReplicaRequestWithDBInstanceIdentifier (const Aws::String &value)
 
PromoteReadReplicaRequestWithDBInstanceIdentifier (Aws::String &&value)
 
PromoteReadReplicaRequestWithDBInstanceIdentifier (const char *value)
 
int GetBackupRetentionPeriod () const
 
bool BackupRetentionPeriodHasBeenSet () const
 
void SetBackupRetentionPeriod (int value)
 
PromoteReadReplicaRequestWithBackupRetentionPeriod (int value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
PromoteReadReplicaRequestWithPreferredBackupWindow (const Aws::String &value)
 
PromoteReadReplicaRequestWithPreferredBackupWindow (Aws::String &&value)
 
PromoteReadReplicaRequestWithPreferredBackupWindow (const char *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 24 of file PromoteReadReplicaRequest.h.

Constructor & Destructor Documentation

◆ PromoteReadReplicaRequest()

Aws::RDS::Model::PromoteReadReplicaRequest::PromoteReadReplicaRequest ( )

Member Function Documentation

◆ BackupRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::PromoteReadReplicaRequest::BackupRetentionPeriodHasBeenSet ( ) const
inline

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35.

  • Can't be set to 0 if the DB instance is a source to read replicas.

Definition at line 115 of file PromoteReadReplicaRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::PromoteReadReplicaRequest::DBInstanceIdentifierHasBeenSet ( ) const
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 54 of file PromoteReadReplicaRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::PromoteReadReplicaRequest::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.

◆ GetBackupRetentionPeriod()

int Aws::RDS::Model::PromoteReadReplicaRequest::GetBackupRetentionPeriod ( ) const
inline

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35.

  • Can't be set to 0 if the DB instance is a source to read replicas.

Definition at line 106 of file PromoteReadReplicaRequest.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::PromoteReadReplicaRequest::GetDBInstanceIdentifier ( ) const
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 47 of file PromoteReadReplicaRequest.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::RDS::Model::PromoteReadReplicaRequest::GetPreferredBackupWindow ( ) const
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 149 of file PromoteReadReplicaRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file PromoteReadReplicaRequest.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::RDS::Model::PromoteReadReplicaRequest::PreferredBackupWindowHasBeenSet ( ) const
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 164 of file PromoteReadReplicaRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBackupRetentionPeriod()

void Aws::RDS::Model::PromoteReadReplicaRequest::SetBackupRetentionPeriod ( int  value)
inline

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35.

  • Can't be set to 0 if the DB instance is a source to read replicas.

Definition at line 124 of file PromoteReadReplicaRequest.h.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::PromoteReadReplicaRequest::SetDBInstanceIdentifier ( Aws::String &&  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 68 of file PromoteReadReplicaRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::PromoteReadReplicaRequest::SetDBInstanceIdentifier ( const Aws::String value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 61 of file PromoteReadReplicaRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::PromoteReadReplicaRequest::SetDBInstanceIdentifier ( const char *  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 75 of file PromoteReadReplicaRequest.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::RDS::Model::PromoteReadReplicaRequest::SetPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 194 of file PromoteReadReplicaRequest.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::RDS::Model::PromoteReadReplicaRequest::SetPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 179 of file PromoteReadReplicaRequest.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::RDS::Model::PromoteReadReplicaRequest::SetPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 209 of file PromoteReadReplicaRequest.h.

◆ WithBackupRetentionPeriod()

PromoteReadReplicaRequest& Aws::RDS::Model::PromoteReadReplicaRequest::WithBackupRetentionPeriod ( int  value)
inline

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35.

  • Can't be set to 0 if the DB instance is a source to read replicas.

Definition at line 133 of file PromoteReadReplicaRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

PromoteReadReplicaRequest& Aws::RDS::Model::PromoteReadReplicaRequest::WithDBInstanceIdentifier ( Aws::String &&  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 89 of file PromoteReadReplicaRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

PromoteReadReplicaRequest& Aws::RDS::Model::PromoteReadReplicaRequest::WithDBInstanceIdentifier ( const Aws::String value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 82 of file PromoteReadReplicaRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

PromoteReadReplicaRequest& Aws::RDS::Model::PromoteReadReplicaRequest::WithDBInstanceIdentifier ( const char *  value)
inline

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing read replica DB instance.

Example: mydbinstance

Definition at line 96 of file PromoteReadReplicaRequest.h.

◆ WithPreferredBackupWindow() [1/3]

PromoteReadReplicaRequest& Aws::RDS::Model::PromoteReadReplicaRequest::WithPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 239 of file PromoteReadReplicaRequest.h.

◆ WithPreferredBackupWindow() [2/3]

PromoteReadReplicaRequest& Aws::RDS::Model::PromoteReadReplicaRequest::WithPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 224 of file PromoteReadReplicaRequest.h.

◆ WithPreferredBackupWindow() [3/3]

PromoteReadReplicaRequest& Aws::RDS::Model::PromoteReadReplicaRequest::WithPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 254 of file PromoteReadReplicaRequest.h.


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