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

#include <BatchModifyClusterSnapshotsRequest.h>

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

Public Member Functions

 BatchModifyClusterSnapshotsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetSnapshotIdentifierList () const
 
bool SnapshotIdentifierListHasBeenSet () const
 
void SetSnapshotIdentifierList (const Aws::Vector< Aws::String > &value)
 
void SetSnapshotIdentifierList (Aws::Vector< Aws::String > &&value)
 
BatchModifyClusterSnapshotsRequestWithSnapshotIdentifierList (const Aws::Vector< Aws::String > &value)
 
BatchModifyClusterSnapshotsRequestWithSnapshotIdentifierList (Aws::Vector< Aws::String > &&value)
 
BatchModifyClusterSnapshotsRequestAddSnapshotIdentifierList (const Aws::String &value)
 
BatchModifyClusterSnapshotsRequestAddSnapshotIdentifierList (Aws::String &&value)
 
BatchModifyClusterSnapshotsRequestAddSnapshotIdentifierList (const char *value)
 
int GetManualSnapshotRetentionPeriod () const
 
bool ManualSnapshotRetentionPeriodHasBeenSet () const
 
void SetManualSnapshotRetentionPeriod (int value)
 
BatchModifyClusterSnapshotsRequestWithManualSnapshotRetentionPeriod (int value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
BatchModifyClusterSnapshotsRequestWithForce (bool 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

Definition at line 22 of file BatchModifyClusterSnapshotsRequest.h.

Constructor & Destructor Documentation

◆ BatchModifyClusterSnapshotsRequest()

Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::BatchModifyClusterSnapshotsRequest ( )

Member Function Documentation

◆ AddSnapshotIdentifierList() [1/3]

BatchModifyClusterSnapshotsRequest& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::AddSnapshotIdentifierList ( const Aws::String value)
inline

A list of snapshot identifiers you want to modify.

Definition at line 73 of file BatchModifyClusterSnapshotsRequest.h.

◆ AddSnapshotIdentifierList() [2/3]

BatchModifyClusterSnapshotsRequest& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::AddSnapshotIdentifierList ( Aws::String &&  value)
inline

A list of snapshot identifiers you want to modify.

Definition at line 78 of file BatchModifyClusterSnapshotsRequest.h.

◆ AddSnapshotIdentifierList() [3/3]

BatchModifyClusterSnapshotsRequest& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::AddSnapshotIdentifierList ( const char *  value)
inline

A list of snapshot identifiers you want to modify.

Definition at line 83 of file BatchModifyClusterSnapshotsRequest.h.

◆ DumpBodyToUrl()

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

◆ ForceHasBeenSet()

bool Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::ForceHasBeenSet ( ) const
inline

A boolean value indicating whether to override an exception if the retention period has passed.

Definition at line 141 of file BatchModifyClusterSnapshotsRequest.h.

◆ GetForce()

bool Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::GetForce ( ) const
inline

A boolean value indicating whether to override an exception if the retention period has passed.

Definition at line 135 of file BatchModifyClusterSnapshotsRequest.h.

◆ GetManualSnapshotRetentionPeriod()

int Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::GetManualSnapshotRetentionPeriod ( ) const
inline

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

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

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

Definition at line 95 of file BatchModifyClusterSnapshotsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file BatchModifyClusterSnapshotsRequest.h.

◆ GetSnapshotIdentifierList()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::GetSnapshotIdentifierList ( ) const
inline

A list of snapshot identifiers you want to modify.

Definition at line 43 of file BatchModifyClusterSnapshotsRequest.h.

◆ ManualSnapshotRetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::ManualSnapshotRetentionPeriodHasBeenSet ( ) const
inline

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

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

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

Definition at line 106 of file BatchModifyClusterSnapshotsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetForce()

void Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::SetForce ( bool  value)
inline

A boolean value indicating whether to override an exception if the retention period has passed.

Definition at line 147 of file BatchModifyClusterSnapshotsRequest.h.

◆ SetManualSnapshotRetentionPeriod()

void Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::SetManualSnapshotRetentionPeriod ( int  value)
inline

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

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

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

Definition at line 117 of file BatchModifyClusterSnapshotsRequest.h.

◆ SetSnapshotIdentifierList() [1/2]

void Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::SetSnapshotIdentifierList ( const Aws::Vector< Aws::String > &  value)
inline

A list of snapshot identifiers you want to modify.

Definition at line 53 of file BatchModifyClusterSnapshotsRequest.h.

◆ SetSnapshotIdentifierList() [2/2]

void Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::SetSnapshotIdentifierList ( Aws::Vector< Aws::String > &&  value)
inline

A list of snapshot identifiers you want to modify.

Definition at line 58 of file BatchModifyClusterSnapshotsRequest.h.

◆ SnapshotIdentifierListHasBeenSet()

bool Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::SnapshotIdentifierListHasBeenSet ( ) const
inline

A list of snapshot identifiers you want to modify.

Definition at line 48 of file BatchModifyClusterSnapshotsRequest.h.

◆ WithForce()

BatchModifyClusterSnapshotsRequest& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::WithForce ( bool  value)
inline

A boolean value indicating whether to override an exception if the retention period has passed.

Definition at line 153 of file BatchModifyClusterSnapshotsRequest.h.

◆ WithManualSnapshotRetentionPeriod()

BatchModifyClusterSnapshotsRequest& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::WithManualSnapshotRetentionPeriod ( int  value)
inline

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

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

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

Definition at line 128 of file BatchModifyClusterSnapshotsRequest.h.

◆ WithSnapshotIdentifierList() [1/2]

BatchModifyClusterSnapshotsRequest& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::WithSnapshotIdentifierList ( const Aws::Vector< Aws::String > &  value)
inline

A list of snapshot identifiers you want to modify.

Definition at line 63 of file BatchModifyClusterSnapshotsRequest.h.

◆ WithSnapshotIdentifierList() [2/2]

BatchModifyClusterSnapshotsRequest& Aws::Redshift::Model::BatchModifyClusterSnapshotsRequest::WithSnapshotIdentifierList ( Aws::Vector< Aws::String > &&  value)
inline

A list of snapshot identifiers you want to modify.

Definition at line 68 of file BatchModifyClusterSnapshotsRequest.h.


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