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

#include <EnableSnapshotCopyRequest.h>

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

Public Member Functions

 EnableSnapshotCopyRequest ()
 
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)
 
EnableSnapshotCopyRequestWithClusterIdentifier (const Aws::String &value)
 
EnableSnapshotCopyRequestWithClusterIdentifier (Aws::String &&value)
 
EnableSnapshotCopyRequestWithClusterIdentifier (const char *value)
 
const Aws::StringGetDestinationRegion () const
 
bool DestinationRegionHasBeenSet () const
 
void SetDestinationRegion (const Aws::String &value)
 
void SetDestinationRegion (Aws::String &&value)
 
void SetDestinationRegion (const char *value)
 
EnableSnapshotCopyRequestWithDestinationRegion (const Aws::String &value)
 
EnableSnapshotCopyRequestWithDestinationRegion (Aws::String &&value)
 
EnableSnapshotCopyRequestWithDestinationRegion (const char *value)
 
int GetRetentionPeriod () const
 
bool RetentionPeriodHasBeenSet () const
 
void SetRetentionPeriod (int value)
 
EnableSnapshotCopyRequestWithRetentionPeriod (int value)
 
const Aws::StringGetSnapshotCopyGrantName () const
 
bool SnapshotCopyGrantNameHasBeenSet () const
 
void SetSnapshotCopyGrantName (const Aws::String &value)
 
void SetSnapshotCopyGrantName (Aws::String &&value)
 
void SetSnapshotCopyGrantName (const char *value)
 
EnableSnapshotCopyRequestWithSnapshotCopyGrantName (const Aws::String &value)
 
EnableSnapshotCopyRequestWithSnapshotCopyGrantName (Aws::String &&value)
 
EnableSnapshotCopyRequestWithSnapshotCopyGrantName (const char *value)
 
int GetManualSnapshotRetentionPeriod () const
 
bool ManualSnapshotRetentionPeriodHasBeenSet () const
 
void SetManualSnapshotRetentionPeriod (int value)
 
EnableSnapshotCopyRequestWithManualSnapshotRetentionPeriod (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 EnableSnapshotCopyRequest.h.

Constructor & Destructor Documentation

◆ EnableSnapshotCopyRequest()

Aws::Redshift::Model::EnableSnapshotCopyRequest::EnableSnapshotCopyRequest ( )

Member Function Documentation

◆ ClusterIdentifierHasBeenSet()

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

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 54 of file EnableSnapshotCopyRequest.h.

◆ DestinationRegionHasBeenSet()

bool Aws::Redshift::Model::EnableSnapshotCopyRequest::DestinationRegionHasBeenSet ( ) const
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 115 of file EnableSnapshotCopyRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::EnableSnapshotCopyRequest::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::EnableSnapshotCopyRequest::GetClusterIdentifier ( ) const
inline

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 47 of file EnableSnapshotCopyRequest.h.

◆ GetDestinationRegion()

const Aws::String& Aws::Redshift::Model::EnableSnapshotCopyRequest::GetDestinationRegion ( ) const
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 106 of file EnableSnapshotCopyRequest.h.

◆ GetManualSnapshotRetentionPeriod()

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

The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. 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.

Definition at line 256 of file EnableSnapshotCopyRequest.h.

◆ GetRetentionPeriod()

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

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

Default: 7.

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

Definition at line 177 of file EnableSnapshotCopyRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file EnableSnapshotCopyRequest.h.

◆ GetSnapshotCopyGrantName()

const Aws::String& Aws::Redshift::Model::EnableSnapshotCopyRequest::GetSnapshotCopyGrantName ( ) const
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 205 of file EnableSnapshotCopyRequest.h.

◆ ManualSnapshotRetentionPeriodHasBeenSet()

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

The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. 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.

Definition at line 264 of file EnableSnapshotCopyRequest.h.

◆ RetentionPeriodHasBeenSet()

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

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

Default: 7.

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

Definition at line 184 of file EnableSnapshotCopyRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterIdentifier() [1/3]

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

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 68 of file EnableSnapshotCopyRequest.h.

◆ SetClusterIdentifier() [2/3]

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

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 61 of file EnableSnapshotCopyRequest.h.

◆ SetClusterIdentifier() [3/3]

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

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 75 of file EnableSnapshotCopyRequest.h.

◆ SetDestinationRegion() [1/3]

void Aws::Redshift::Model::EnableSnapshotCopyRequest::SetDestinationRegion ( Aws::String &&  value)
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 133 of file EnableSnapshotCopyRequest.h.

◆ SetDestinationRegion() [2/3]

void Aws::Redshift::Model::EnableSnapshotCopyRequest::SetDestinationRegion ( const Aws::String value)
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 124 of file EnableSnapshotCopyRequest.h.

◆ SetDestinationRegion() [3/3]

void Aws::Redshift::Model::EnableSnapshotCopyRequest::SetDestinationRegion ( const char *  value)
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 142 of file EnableSnapshotCopyRequest.h.

◆ SetManualSnapshotRetentionPeriod()

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

The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. 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.

Definition at line 272 of file EnableSnapshotCopyRequest.h.

◆ SetRetentionPeriod()

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

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

Default: 7.

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

Definition at line 191 of file EnableSnapshotCopyRequest.h.

◆ SetSnapshotCopyGrantName() [1/3]

void Aws::Redshift::Model::EnableSnapshotCopyRequest::SetSnapshotCopyGrantName ( Aws::String &&  value)
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 223 of file EnableSnapshotCopyRequest.h.

◆ SetSnapshotCopyGrantName() [2/3]

void Aws::Redshift::Model::EnableSnapshotCopyRequest::SetSnapshotCopyGrantName ( const Aws::String value)
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 217 of file EnableSnapshotCopyRequest.h.

◆ SetSnapshotCopyGrantName() [3/3]

void Aws::Redshift::Model::EnableSnapshotCopyRequest::SetSnapshotCopyGrantName ( const char *  value)
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 229 of file EnableSnapshotCopyRequest.h.

◆ SnapshotCopyGrantNameHasBeenSet()

bool Aws::Redshift::Model::EnableSnapshotCopyRequest::SnapshotCopyGrantNameHasBeenSet ( ) const
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 211 of file EnableSnapshotCopyRequest.h.

◆ WithClusterIdentifier() [1/3]

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

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 89 of file EnableSnapshotCopyRequest.h.

◆ WithClusterIdentifier() [2/3]

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

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 82 of file EnableSnapshotCopyRequest.h.

◆ WithClusterIdentifier() [3/3]

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

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Definition at line 96 of file EnableSnapshotCopyRequest.h.

◆ WithDestinationRegion() [1/3]

EnableSnapshotCopyRequest& Aws::Redshift::Model::EnableSnapshotCopyRequest::WithDestinationRegion ( Aws::String &&  value)
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 160 of file EnableSnapshotCopyRequest.h.

◆ WithDestinationRegion() [2/3]

EnableSnapshotCopyRequest& Aws::Redshift::Model::EnableSnapshotCopyRequest::WithDestinationRegion ( const Aws::String value)
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 151 of file EnableSnapshotCopyRequest.h.

◆ WithDestinationRegion() [3/3]

EnableSnapshotCopyRequest& Aws::Redshift::Model::EnableSnapshotCopyRequest::WithDestinationRegion ( const char *  value)
inline

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Definition at line 169 of file EnableSnapshotCopyRequest.h.

◆ WithManualSnapshotRetentionPeriod()

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

The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. 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.

Definition at line 280 of file EnableSnapshotCopyRequest.h.

◆ WithRetentionPeriod()

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

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

Default: 7.

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

Definition at line 198 of file EnableSnapshotCopyRequest.h.

◆ WithSnapshotCopyGrantName() [1/3]

EnableSnapshotCopyRequest& Aws::Redshift::Model::EnableSnapshotCopyRequest::WithSnapshotCopyGrantName ( Aws::String &&  value)
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 241 of file EnableSnapshotCopyRequest.h.

◆ WithSnapshotCopyGrantName() [2/3]

EnableSnapshotCopyRequest& Aws::Redshift::Model::EnableSnapshotCopyRequest::WithSnapshotCopyGrantName ( const Aws::String value)
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 235 of file EnableSnapshotCopyRequest.h.

◆ WithSnapshotCopyGrantName() [3/3]

EnableSnapshotCopyRequest& Aws::Redshift::Model::EnableSnapshotCopyRequest::WithSnapshotCopyGrantName ( const char *  value)
inline

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Definition at line 247 of file EnableSnapshotCopyRequest.h.


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