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

#include <DeleteDBInstanceRequest.h>

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

Public Member Functions

 DeleteDBInstanceRequest ()
 
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)
 
DeleteDBInstanceRequestWithDBInstanceIdentifier (const Aws::String &value)
 
DeleteDBInstanceRequestWithDBInstanceIdentifier (Aws::String &&value)
 
DeleteDBInstanceRequestWithDBInstanceIdentifier (const char *value)
 
bool GetSkipFinalSnapshot () const
 
bool SkipFinalSnapshotHasBeenSet () const
 
void SetSkipFinalSnapshot (bool value)
 
DeleteDBInstanceRequestWithSkipFinalSnapshot (bool value)
 
const Aws::StringGetFinalDBSnapshotIdentifier () const
 
bool FinalDBSnapshotIdentifierHasBeenSet () const
 
void SetFinalDBSnapshotIdentifier (const Aws::String &value)
 
void SetFinalDBSnapshotIdentifier (Aws::String &&value)
 
void SetFinalDBSnapshotIdentifier (const char *value)
 
DeleteDBInstanceRequestWithFinalDBSnapshotIdentifier (const Aws::String &value)
 
DeleteDBInstanceRequestWithFinalDBSnapshotIdentifier (Aws::String &&value)
 
DeleteDBInstanceRequestWithFinalDBSnapshotIdentifier (const char *value)
 
bool GetDeleteAutomatedBackups () const
 
bool DeleteAutomatedBackupsHasBeenSet () const
 
void SetDeleteAutomatedBackups (bool value)
 
DeleteDBInstanceRequestWithDeleteAutomatedBackups (bool 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 DeleteDBInstanceRequest.h.

Constructor & Destructor Documentation

◆ DeleteDBInstanceRequest()

Aws::RDS::Model::DeleteDBInstanceRequest::DeleteDBInstanceRequest ( )

Member Function Documentation

◆ DBInstanceIdentifierHasBeenSet()

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 54 of file DeleteDBInstanceRequest.h.

◆ DeleteAutomatedBackupsHasBeenSet()

bool Aws::RDS::Model::DeleteDBInstanceRequest::DeleteAutomatedBackupsHasBeenSet ( ) const
inline

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Definition at line 261 of file DeleteDBInstanceRequest.h.

◆ DumpBodyToUrl()

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

◆ FinalDBSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::DeleteDBInstanceRequest::FinalDBSnapshotIdentifierHasBeenSet ( ) const
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 174 of file DeleteDBInstanceRequest.h.

◆ GetDBInstanceIdentifier()

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 47 of file DeleteDBInstanceRequest.h.

◆ GetDeleteAutomatedBackups()

bool Aws::RDS::Model::DeleteDBInstanceRequest::GetDeleteAutomatedBackups ( ) const
inline

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Definition at line 254 of file DeleteDBInstanceRequest.h.

◆ GetFinalDBSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::DeleteDBInstanceRequest::GetFinalDBSnapshotIdentifier ( ) const
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 162 of file DeleteDBInstanceRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DeleteDBInstanceRequest.h.

◆ GetSkipFinalSnapshot()

bool Aws::RDS::Model::DeleteDBInstanceRequest::GetSkipFinalSnapshot ( ) const
inline

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

Definition at line 110 of file DeleteDBInstanceRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBInstanceIdentifier() [1/3]

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 68 of file DeleteDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 61 of file DeleteDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 75 of file DeleteDBInstanceRequest.h.

◆ SetDeleteAutomatedBackups()

void Aws::RDS::Model::DeleteDBInstanceRequest::SetDeleteAutomatedBackups ( bool  value)
inline

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Definition at line 268 of file DeleteDBInstanceRequest.h.

◆ SetFinalDBSnapshotIdentifier() [1/3]

void Aws::RDS::Model::DeleteDBInstanceRequest::SetFinalDBSnapshotIdentifier ( Aws::String &&  value)
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 198 of file DeleteDBInstanceRequest.h.

◆ SetFinalDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::DeleteDBInstanceRequest::SetFinalDBSnapshotIdentifier ( const Aws::String value)
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 186 of file DeleteDBInstanceRequest.h.

◆ SetFinalDBSnapshotIdentifier() [3/3]

void Aws::RDS::Model::DeleteDBInstanceRequest::SetFinalDBSnapshotIdentifier ( const char *  value)
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 210 of file DeleteDBInstanceRequest.h.

◆ SetSkipFinalSnapshot()

void Aws::RDS::Model::DeleteDBInstanceRequest::SetSkipFinalSnapshot ( bool  value)
inline

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

Definition at line 136 of file DeleteDBInstanceRequest.h.

◆ SkipFinalSnapshotHasBeenSet()

bool Aws::RDS::Model::DeleteDBInstanceRequest::SkipFinalSnapshotHasBeenSet ( ) const
inline

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

Definition at line 123 of file DeleteDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 89 of file DeleteDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 82 of file DeleteDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

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

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

Definition at line 96 of file DeleteDBInstanceRequest.h.

◆ WithDeleteAutomatedBackups()

DeleteDBInstanceRequest& Aws::RDS::Model::DeleteDBInstanceRequest::WithDeleteAutomatedBackups ( bool  value)
inline

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Definition at line 275 of file DeleteDBInstanceRequest.h.

◆ WithFinalDBSnapshotIdentifier() [1/3]

DeleteDBInstanceRequest& Aws::RDS::Model::DeleteDBInstanceRequest::WithFinalDBSnapshotIdentifier ( Aws::String &&  value)
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 234 of file DeleteDBInstanceRequest.h.

◆ WithFinalDBSnapshotIdentifier() [2/3]

DeleteDBInstanceRequest& Aws::RDS::Model::DeleteDBInstanceRequest::WithFinalDBSnapshotIdentifier ( const Aws::String value)
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 222 of file DeleteDBInstanceRequest.h.

◆ WithFinalDBSnapshotIdentifier() [3/3]

DeleteDBInstanceRequest& Aws::RDS::Model::DeleteDBInstanceRequest::WithFinalDBSnapshotIdentifier ( const char *  value)
inline

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

Definition at line 246 of file DeleteDBInstanceRequest.h.

◆ WithSkipFinalSnapshot()

DeleteDBInstanceRequest& Aws::RDS::Model::DeleteDBInstanceRequest::WithSkipFinalSnapshot ( bool  value)
inline

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

Definition at line 149 of file DeleteDBInstanceRequest.h.


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