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

#include <DeleteClusterRequest.h>

+ Inheritance diagram for Aws::Redshift::Model::DeleteClusterRequest:

Public Member Functions

 DeleteClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
DeleteClusterRequestWithClusterIdentifier (const Aws::String &value)
 
DeleteClusterRequestWithClusterIdentifier (Aws::String &&value)
 
DeleteClusterRequestWithClusterIdentifier (const char *value)
 
bool GetSkipFinalClusterSnapshot () const
 
bool SkipFinalClusterSnapshotHasBeenSet () const
 
void SetSkipFinalClusterSnapshot (bool value)
 
DeleteClusterRequestWithSkipFinalClusterSnapshot (bool value)
 
const Aws::StringGetFinalClusterSnapshotIdentifier () const
 
bool FinalClusterSnapshotIdentifierHasBeenSet () const
 
void SetFinalClusterSnapshotIdentifier (const Aws::String &value)
 
void SetFinalClusterSnapshotIdentifier (Aws::String &&value)
 
void SetFinalClusterSnapshotIdentifier (const char *value)
 
DeleteClusterRequestWithFinalClusterSnapshotIdentifier (const Aws::String &value)
 
DeleteClusterRequestWithFinalClusterSnapshotIdentifier (Aws::String &&value)
 
DeleteClusterRequestWithFinalClusterSnapshotIdentifier (const char *value)
 
int GetFinalClusterSnapshotRetentionPeriod () const
 
bool FinalClusterSnapshotRetentionPeriodHasBeenSet () const
 
void SetFinalClusterSnapshotRetentionPeriod (int value)
 
DeleteClusterRequestWithFinalClusterSnapshotRetentionPeriod (int value)
 
- Public Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual ~RedshiftRequest ()
 
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::Redshift::RedshiftRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 24 of file DeleteClusterRequest.h.

Constructor & Destructor Documentation

◆ DeleteClusterRequest()

Aws::Redshift::Model::DeleteClusterRequest::DeleteClusterRequest ( )

Member Function Documentation

◆ ClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::DeleteClusterRequest::ClusterIdentifierHasBeenSet ( ) const
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 58 of file DeleteClusterRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::DeleteClusterRequest::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.

◆ FinalClusterSnapshotIdentifierHasBeenSet()

bool Aws::Redshift::Model::DeleteClusterRequest::FinalClusterSnapshotIdentifierHasBeenSet ( ) const
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 174 of file DeleteClusterRequest.h.

◆ FinalClusterSnapshotRetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::DeleteClusterRequest::FinalClusterSnapshotRetentionPeriodHasBeenSet ( ) const
inline

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.

Definition at line 249 of file DeleteClusterRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::Redshift::Model::DeleteClusterRequest::GetClusterIdentifier ( ) const
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 49 of file DeleteClusterRequest.h.

◆ GetFinalClusterSnapshotIdentifier()

const Aws::String& Aws::Redshift::Model::DeleteClusterRequest::GetFinalClusterSnapshotIdentifier ( ) const
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 164 of file DeleteClusterRequest.h.

◆ GetFinalClusterSnapshotRetentionPeriod()

int Aws::Redshift::Model::DeleteClusterRequest::GetFinalClusterSnapshotRetentionPeriod ( ) const
inline

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.

Definition at line 242 of file DeleteClusterRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Redshift::Model::DeleteClusterRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DeleteClusterRequest.h.

◆ GetSkipFinalClusterSnapshot()

bool Aws::Redshift::Model::DeleteClusterRequest::GetSkipFinalClusterSnapshot ( ) const
inline

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Definition at line 123 of file DeleteClusterRequest.h.

◆ SerializePayload()

Aws::String Aws::Redshift::Model::DeleteClusterRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterIdentifier() [1/3]

void Aws::Redshift::Model::DeleteClusterRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 76 of file DeleteClusterRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::Redshift::Model::DeleteClusterRequest::SetClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 67 of file DeleteClusterRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::Redshift::Model::DeleteClusterRequest::SetClusterIdentifier ( const char *  value)
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 85 of file DeleteClusterRequest.h.

◆ SetFinalClusterSnapshotIdentifier() [1/3]

void Aws::Redshift::Model::DeleteClusterRequest::SetFinalClusterSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 194 of file DeleteClusterRequest.h.

◆ SetFinalClusterSnapshotIdentifier() [2/3]

void Aws::Redshift::Model::DeleteClusterRequest::SetFinalClusterSnapshotIdentifier ( const Aws::String value)
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 184 of file DeleteClusterRequest.h.

◆ SetFinalClusterSnapshotIdentifier() [3/3]

void Aws::Redshift::Model::DeleteClusterRequest::SetFinalClusterSnapshotIdentifier ( const char *  value)
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 204 of file DeleteClusterRequest.h.

◆ SetFinalClusterSnapshotRetentionPeriod()

void Aws::Redshift::Model::DeleteClusterRequest::SetFinalClusterSnapshotRetentionPeriod ( int  value)
inline

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.

Definition at line 256 of file DeleteClusterRequest.h.

◆ SetSkipFinalClusterSnapshot()

void Aws::Redshift::Model::DeleteClusterRequest::SetSkipFinalClusterSnapshot ( bool  value)
inline

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Definition at line 143 of file DeleteClusterRequest.h.

◆ SkipFinalClusterSnapshotHasBeenSet()

bool Aws::Redshift::Model::DeleteClusterRequest::SkipFinalClusterSnapshotHasBeenSet ( ) const
inline

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Definition at line 133 of file DeleteClusterRequest.h.

◆ WithClusterIdentifier() [1/3]

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 103 of file DeleteClusterRequest.h.

◆ WithClusterIdentifier() [2/3]

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 94 of file DeleteClusterRequest.h.

◆ WithClusterIdentifier() [3/3]

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithClusterIdentifier ( const char *  value)
inline

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Definition at line 112 of file DeleteClusterRequest.h.

◆ WithFinalClusterSnapshotIdentifier() [1/3]

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithFinalClusterSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 224 of file DeleteClusterRequest.h.

◆ WithFinalClusterSnapshotIdentifier() [2/3]

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithFinalClusterSnapshotIdentifier ( const Aws::String value)
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 214 of file DeleteClusterRequest.h.

◆ WithFinalClusterSnapshotIdentifier() [3/3]

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithFinalClusterSnapshotIdentifier ( const char *  value)
inline

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

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

Definition at line 234 of file DeleteClusterRequest.h.

◆ WithFinalClusterSnapshotRetentionPeriod()

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithFinalClusterSnapshotRetentionPeriod ( int  value)
inline

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.

Definition at line 263 of file DeleteClusterRequest.h.

◆ WithSkipFinalClusterSnapshot()

DeleteClusterRequest& Aws::Redshift::Model::DeleteClusterRequest::WithSkipFinalClusterSnapshot ( bool  value)
inline

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Definition at line 153 of file DeleteClusterRequest.h.


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