Aws::RDS::Model::DeleteDBClusterRequest Class Reference

#include <DeleteDBClusterRequest.h>

Inheritance diagram for Aws::RDS::Model::DeleteDBClusterRequest:

Public Member Functions
	DeleteDBClusterRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
const Aws::String &	GetDBClusterIdentifier () const
bool	DBClusterIdentifierHasBeenSet () const
void	SetDBClusterIdentifier (const Aws::String &value)
void	SetDBClusterIdentifier (Aws::String &&value)
void	SetDBClusterIdentifier (const char *value)
DeleteDBClusterRequest &	WithDBClusterIdentifier (const Aws::String &value)
DeleteDBClusterRequest &	WithDBClusterIdentifier (Aws::String &&value)
DeleteDBClusterRequest &	WithDBClusterIdentifier (const char *value)
bool	GetSkipFinalSnapshot () const
bool	SkipFinalSnapshotHasBeenSet () const
void	SetSkipFinalSnapshot (bool value)
DeleteDBClusterRequest &	WithSkipFinalSnapshot (bool value)
const Aws::String &	GetFinalDBSnapshotIdentifier () const
bool	FinalDBSnapshotIdentifierHasBeenSet () const
void	SetFinalDBSnapshotIdentifier (const Aws::String &value)
void	SetFinalDBSnapshotIdentifier (Aws::String &&value)
void	SetFinalDBSnapshotIdentifier (const char *value)
DeleteDBClusterRequest &	WithFinalDBSnapshotIdentifier (const Aws::String &value)
DeleteDBClusterRequest &	WithFinalDBSnapshotIdentifier (Aws::String &&value)
DeleteDBClusterRequest &	WithFinalDBSnapshotIdentifier (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 DeleteDBClusterRequest.h.

Constructor & Destructor Documentation

DeleteDBClusterRequest()

Aws::RDS::Model::DeleteDBClusterRequest::DeleteDBClusterRequest

(

)

Member Function Documentation

DBClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::DeleteDBClusterRequest::DBClusterIdentifierHasBeenSet ( ) const

inline

The DB cluster identifier for the DB 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::RDS::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::RDS::Model::DeleteDBClusterRequest::FinalDBSnapshotIdentifierHasBeenSet ( ) const

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 164 of file DeleteDBClusterRequest.h.

GetDBClusterIdentifier()

const Aws::String& Aws::RDS::Model::DeleteDBClusterRequest::GetDBClusterIdentifier ( ) const

inline

The DB cluster identifier for the DB 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::RDS::Model::DeleteDBClusterRequest::GetFinalDBSnapshotIdentifier ( ) const

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 153 of file DeleteDBClusterRequest.h.

GetServiceRequestName()

virtual const char* Aws::RDS::Model::DeleteDBClusterRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DeleteDBClusterRequest.h.

GetSkipFinalSnapshot()

bool Aws::RDS::Model::DeleteDBClusterRequest::GetSkipFinalSnapshot ( ) const

inline

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

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

Definition at line 108 of file DeleteDBClusterRequest.h.

SerializePayload()

Aws::String Aws::RDS::Model::DeleteDBClusterRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetDBClusterIdentifier() [1/3]

void Aws::RDS::Model::DeleteDBClusterRequest::SetDBClusterIdentifier ( Aws::String &&  value )

inline

The DB cluster identifier for the DB 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() [2/3]

void Aws::RDS::Model::DeleteDBClusterRequest::SetDBClusterIdentifier ( const Aws::String &  value )

inline

The DB cluster identifier for the DB 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() [3/3]

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

inline

The DB cluster identifier for the DB 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::RDS::Model::DeleteDBClusterRequest::SetFinalDBSnapshotIdentifier ( Aws::String &&  value )

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 186 of file DeleteDBClusterRequest.h.

SetFinalDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::DeleteDBClusterRequest::SetFinalDBSnapshotIdentifier ( const Aws::String &  value )

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 175 of file DeleteDBClusterRequest.h.

SetFinalDBSnapshotIdentifier() [3/3]

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

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 197 of file DeleteDBClusterRequest.h.

SetSkipFinalSnapshot()

void Aws::RDS::Model::DeleteDBClusterRequest::SetSkipFinalSnapshot ( bool  value )

inline

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

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

Definition at line 130 of file DeleteDBClusterRequest.h.

SkipFinalSnapshotHasBeenSet()

bool Aws::RDS::Model::DeleteDBClusterRequest::SkipFinalSnapshotHasBeenSet ( ) const

inline

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

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

Definition at line 119 of file DeleteDBClusterRequest.h.

WithDBClusterIdentifier() [1/3]

DeleteDBClusterRequest& Aws::RDS::Model::DeleteDBClusterRequest::WithDBClusterIdentifier ( Aws::String &&  value )

inline

The DB cluster identifier for the DB 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() [2/3]

DeleteDBClusterRequest& Aws::RDS::Model::DeleteDBClusterRequest::WithDBClusterIdentifier ( const Aws::String &  value )

inline

The DB cluster identifier for the DB 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() [3/3]

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

inline

The DB cluster identifier for the DB 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::RDS::Model::DeleteDBClusterRequest::WithFinalDBSnapshotIdentifier ( Aws::String &&  value )

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 219 of file DeleteDBClusterRequest.h.

WithFinalDBSnapshotIdentifier() [2/3]

DeleteDBClusterRequest& Aws::RDS::Model::DeleteDBClusterRequest::WithFinalDBSnapshotIdentifier ( const Aws::String &  value )

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 208 of file DeleteDBClusterRequest.h.

WithFinalDBSnapshotIdentifier() [3/3]

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

inline

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

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

Definition at line 230 of file DeleteDBClusterRequest.h.

WithSkipFinalSnapshot()

DeleteDBClusterRequest& Aws::RDS::Model::DeleteDBClusterRequest::WithSkipFinalSnapshot ( bool  value )

inline

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

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

Definition at line 141 of file DeleteDBClusterRequest.h.

---

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

• aws-cpp-sdk-rds/include/aws/rds/model/DeleteDBClusterRequest.h