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

#include <DeleteDBClusterRequest.h>

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

Public Member Functions

 DeleteDBClusterRequest ()
 
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)
 
DeleteDBClusterRequestWithDBClusterIdentifier (const Aws::String &value)
 
DeleteDBClusterRequestWithDBClusterIdentifier (Aws::String &&value)
 
DeleteDBClusterRequestWithDBClusterIdentifier (const char *value)
 
bool GetSkipFinalSnapshot () const
 
bool SkipFinalSnapshotHasBeenSet () const
 
void SetSkipFinalSnapshot (bool value)
 
DeleteDBClusterRequestWithSkipFinalSnapshot (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)
 
DeleteDBClusterRequestWithFinalDBSnapshotIdentifier (const Aws::String &value)
 
DeleteDBClusterRequestWithFinalDBSnapshotIdentifier (Aws::String &&value)
 
DeleteDBClusterRequestWithFinalDBSnapshotIdentifier (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 DeleteDBCluster.

See Also:

AWS API Reference

Definition at line 24 of file DeleteDBClusterRequest.h.

Constructor & Destructor Documentation

◆ DeleteDBClusterRequest()

Aws::DocDB::Model::DeleteDBClusterRequest::DeleteDBClusterRequest ( )

Member Function Documentation

◆ DBClusterIdentifierHasBeenSet()

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 54 of file DeleteDBClusterRequest.h.

◆ DumpBodyToUrl()

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

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 160 of file DeleteDBClusterRequest.h.

◆ GetDBClusterIdentifier()

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 47 of file DeleteDBClusterRequest.h.

◆ GetFinalDBSnapshotIdentifier()

const Aws::String& Aws::DocDB::Model::DeleteDBClusterRequest::GetFinalDBSnapshotIdentifier ( ) const
inline

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 149 of file DeleteDBClusterRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DeleteDBClusterRequest.h.

◆ GetSkipFinalSnapshot()

bool Aws::DocDB::Model::DeleteDBClusterRequest::GetSkipFinalSnapshot ( ) const
inline

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

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

Definition at line 107 of file DeleteDBClusterRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBClusterIdentifier() [1/3]

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 61 of file DeleteDBClusterRequest.h.

◆ SetDBClusterIdentifier() [2/3]

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 68 of file DeleteDBClusterRequest.h.

◆ SetDBClusterIdentifier() [3/3]

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 75 of file DeleteDBClusterRequest.h.

◆ SetFinalDBSnapshotIdentifier() [1/3]

void Aws::DocDB::Model::DeleteDBClusterRequest::SetFinalDBSnapshotIdentifier ( const Aws::String value)
inline

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 171 of file DeleteDBClusterRequest.h.

◆ SetFinalDBSnapshotIdentifier() [2/3]

void Aws::DocDB::Model::DeleteDBClusterRequest::SetFinalDBSnapshotIdentifier ( Aws::String &&  value)
inline

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 182 of file DeleteDBClusterRequest.h.

◆ SetFinalDBSnapshotIdentifier() [3/3]

void Aws::DocDB::Model::DeleteDBClusterRequest::SetFinalDBSnapshotIdentifier ( const char *  value)
inline

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 193 of file DeleteDBClusterRequest.h.

◆ SetSkipFinalSnapshot()

void Aws::DocDB::Model::DeleteDBClusterRequest::SetSkipFinalSnapshot ( bool  value)
inline

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

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

Definition at line 127 of file DeleteDBClusterRequest.h.

◆ SkipFinalSnapshotHasBeenSet()

bool Aws::DocDB::Model::DeleteDBClusterRequest::SkipFinalSnapshotHasBeenSet ( ) const
inline

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

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

Definition at line 117 of file DeleteDBClusterRequest.h.

◆ WithDBClusterIdentifier() [1/3]

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 82 of file DeleteDBClusterRequest.h.

◆ WithDBClusterIdentifier() [2/3]

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 89 of file DeleteDBClusterRequest.h.

◆ WithDBClusterIdentifier() [3/3]

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

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

Definition at line 96 of file DeleteDBClusterRequest.h.

◆ WithFinalDBSnapshotIdentifier() [1/3]

DeleteDBClusterRequest& Aws::DocDB::Model::DeleteDBClusterRequest::WithFinalDBSnapshotIdentifier ( const Aws::String value)
inline

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 204 of file DeleteDBClusterRequest.h.

◆ WithFinalDBSnapshotIdentifier() [2/3]

DeleteDBClusterRequest& Aws::DocDB::Model::DeleteDBClusterRequest::WithFinalDBSnapshotIdentifier ( Aws::String &&  value)
inline

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 215 of file DeleteDBClusterRequest.h.

◆ WithFinalDBSnapshotIdentifier() [3/3]

DeleteDBClusterRequest& Aws::DocDB::Model::DeleteDBClusterRequest::WithFinalDBSnapshotIdentifier ( const char *  value)
inline

The cluster snapshot identifier of the new cluster snapshot 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 from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 226 of file DeleteDBClusterRequest.h.

◆ WithSkipFinalSnapshot()

DeleteDBClusterRequest& Aws::DocDB::Model::DeleteDBClusterRequest::WithSkipFinalSnapshot ( bool  value)
inline

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

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

Definition at line 137 of file DeleteDBClusterRequest.h.


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