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

#include <DeleteDBInstanceRequest.h>

+ Inheritance diagram for Aws::Neptune::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)
 
- Public Member Functions inherited from Aws::Neptune::NeptuneRequest
virtual ~NeptuneRequest ()
 
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::Neptune::NeptuneRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 21 of file DeleteDBInstanceRequest.h.

Constructor & Destructor Documentation

◆ DeleteDBInstanceRequest()

Aws::Neptune::Model::DeleteDBInstanceRequest::DeleteDBInstanceRequest ( )

Member Function Documentation

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::Neptune::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 51 of file DeleteDBInstanceRequest.h.

◆ DumpBodyToUrl()

void Aws::Neptune::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::Neptune::Model::DeleteDBInstanceRequest::FinalDBSnapshotIdentifierHasBeenSet ( ) const
inline

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 169 of file DeleteDBInstanceRequest.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::Neptune::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 44 of file DeleteDBInstanceRequest.h.

◆ GetFinalDBSnapshotIdentifier()

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

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 158 of file DeleteDBInstanceRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DeleteDBInstanceRequest.h.

◆ GetSkipFinalSnapshot()

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

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that 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 the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Definition at line 107 of file DeleteDBInstanceRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::Neptune::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 58 of file DeleteDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::Neptune::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 65 of file DeleteDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

void Aws::Neptune::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 72 of file DeleteDBInstanceRequest.h.

◆ SetFinalDBSnapshotIdentifier() [1/3]

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

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 180 of file DeleteDBInstanceRequest.h.

◆ SetFinalDBSnapshotIdentifier() [2/3]

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

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 191 of file DeleteDBInstanceRequest.h.

◆ SetFinalDBSnapshotIdentifier() [3/3]

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

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 202 of file DeleteDBInstanceRequest.h.

◆ SetSkipFinalSnapshot()

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

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that 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 the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Definition at line 133 of file DeleteDBInstanceRequest.h.

◆ SkipFinalSnapshotHasBeenSet()

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

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that 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 the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Definition at line 120 of file DeleteDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

DeleteDBInstanceRequest& Aws::Neptune::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 79 of file DeleteDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

DeleteDBInstanceRequest& Aws::Neptune::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 86 of file DeleteDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

DeleteDBInstanceRequest& Aws::Neptune::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 93 of file DeleteDBInstanceRequest.h.

◆ WithFinalDBSnapshotIdentifier() [1/3]

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

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 213 of file DeleteDBInstanceRequest.h.

◆ WithFinalDBSnapshotIdentifier() [2/3]

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

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 224 of file DeleteDBInstanceRequest.h.

◆ WithFinalDBSnapshotIdentifier() [3/3]

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

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Definition at line 235 of file DeleteDBInstanceRequest.h.

◆ WithSkipFinalSnapshot()

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

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that 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 the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Definition at line 146 of file DeleteDBInstanceRequest.h.


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