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

#include <ModifySnapshotCopyRetentionPeriodRequest.h>

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

Public Member Functions

 ModifySnapshotCopyRetentionPeriodRequest ()
 
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)
 
ModifySnapshotCopyRetentionPeriodRequestWithClusterIdentifier (const Aws::String &value)
 
ModifySnapshotCopyRetentionPeriodRequestWithClusterIdentifier (Aws::String &&value)
 
ModifySnapshotCopyRetentionPeriodRequestWithClusterIdentifier (const char *value)
 
int GetRetentionPeriod () const
 
bool RetentionPeriodHasBeenSet () const
 
void SetRetentionPeriod (int value)
 
ModifySnapshotCopyRetentionPeriodRequestWithRetentionPeriod (int value)
 
bool GetManual () const
 
bool ManualHasBeenSet () const
 
void SetManual (bool value)
 
ModifySnapshotCopyRetentionPeriodRequestWithManual (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

See Also:

AWS API Reference

Definition at line 24 of file ModifySnapshotCopyRetentionPeriodRequest.h.

Constructor & Destructor Documentation

◆ ModifySnapshotCopyRetentionPeriodRequest()

Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::ModifySnapshotCopyRetentionPeriodRequest ( )

Member Function Documentation

◆ ClusterIdentifierHasBeenSet()

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 56 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ DumpBodyToUrl()

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

◆ GetClusterIdentifier()

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 48 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ GetManual()

bool Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::GetManual ( ) const
inline

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Definition at line 176 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ GetRetentionPeriod()

int Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::GetRetentionPeriod ( ) const
inline

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Definition at line 121 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ GetServiceRequestName()

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

◆ ManualHasBeenSet()

bool Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::ManualHasBeenSet ( ) const
inline

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Definition at line 182 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ RetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::RetentionPeriodHasBeenSet ( ) const
inline

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Definition at line 137 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterIdentifier() [1/3]

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 64 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ SetClusterIdentifier() [2/3]

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 72 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ SetClusterIdentifier() [3/3]

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 80 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ SetManual()

void Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::SetManual ( bool  value)
inline

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Definition at line 188 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ SetRetentionPeriod()

void Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::SetRetentionPeriod ( int  value)
inline

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Definition at line 153 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ WithClusterIdentifier() [1/3]

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 88 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ WithClusterIdentifier() [2/3]

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 96 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ WithClusterIdentifier() [3/3]

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

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Definition at line 104 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ WithManual()

ModifySnapshotCopyRetentionPeriodRequest& Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::WithManual ( bool  value)
inline

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Definition at line 194 of file ModifySnapshotCopyRetentionPeriodRequest.h.

◆ WithRetentionPeriod()

ModifySnapshotCopyRetentionPeriodRequest& Aws::Redshift::Model::ModifySnapshotCopyRetentionPeriodRequest::WithRetentionPeriod ( int  value)
inline

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Definition at line 169 of file ModifySnapshotCopyRetentionPeriodRequest.h.


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