AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::ElastiCache::Model::CopySnapshotRequest Class Reference

#include <CopySnapshotRequest.h>

+ Inheritance diagram for Aws::ElastiCache::Model::CopySnapshotRequest:

Public Member Functions

 CopySnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetSourceSnapshotName () const
 
bool SourceSnapshotNameHasBeenSet () const
 
void SetSourceSnapshotName (const Aws::String &value)
 
void SetSourceSnapshotName (Aws::String &&value)
 
void SetSourceSnapshotName (const char *value)
 
CopySnapshotRequestWithSourceSnapshotName (const Aws::String &value)
 
CopySnapshotRequestWithSourceSnapshotName (Aws::String &&value)
 
CopySnapshotRequestWithSourceSnapshotName (const char *value)
 
const Aws::StringGetTargetSnapshotName () const
 
bool TargetSnapshotNameHasBeenSet () const
 
void SetTargetSnapshotName (const Aws::String &value)
 
void SetTargetSnapshotName (Aws::String &&value)
 
void SetTargetSnapshotName (const char *value)
 
CopySnapshotRequestWithTargetSnapshotName (const Aws::String &value)
 
CopySnapshotRequestWithTargetSnapshotName (Aws::String &&value)
 
CopySnapshotRequestWithTargetSnapshotName (const char *value)
 
const Aws::StringGetTargetBucket () const
 
bool TargetBucketHasBeenSet () const
 
void SetTargetBucket (const Aws::String &value)
 
void SetTargetBucket (Aws::String &&value)
 
void SetTargetBucket (const char *value)
 
CopySnapshotRequestWithTargetBucket (const Aws::String &value)
 
CopySnapshotRequestWithTargetBucket (Aws::String &&value)
 
CopySnapshotRequestWithTargetBucket (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CopySnapshotRequestWithKmsKeyId (const Aws::String &value)
 
CopySnapshotRequestWithKmsKeyId (Aws::String &&value)
 
CopySnapshotRequestWithKmsKeyId (const char *value)
 
- Public Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual ~ElastiCacheRequest ()
 
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::ElastiCache::ElastiCacheRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input of a CopySnapshotMessage operation.

See Also:

AWS API Reference

Definition at line 25 of file CopySnapshotRequest.h.

Constructor & Destructor Documentation

◆ CopySnapshotRequest()

Aws::ElastiCache::Model::CopySnapshotRequest::CopySnapshotRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::ElastiCache::Model::CopySnapshotRequest::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.

◆ GetKmsKeyId()

const Aws::String& Aws::ElastiCache::Model::CopySnapshotRequest::GetKmsKeyId ( ) const
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 249 of file CopySnapshotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ElastiCache::Model::CopySnapshotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CopySnapshotRequest.h.

◆ GetSourceSnapshotName()

const Aws::String& Aws::ElastiCache::Model::CopySnapshotRequest::GetSourceSnapshotName ( ) const
inline

The name of an existing snapshot from which to make a copy.

Definition at line 46 of file CopySnapshotRequest.h.

◆ GetTargetBucket()

const Aws::String& Aws::ElastiCache::Model::CopySnapshotRequest::GetTargetBucket ( ) const
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 152 of file CopySnapshotRequest.h.

◆ GetTargetSnapshotName()

const Aws::String& Aws::ElastiCache::Model::CopySnapshotRequest::GetTargetSnapshotName ( ) const
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 89 of file CopySnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::ElastiCache::Model::CopySnapshotRequest::KmsKeyIdHasBeenSet ( ) const
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 254 of file CopySnapshotRequest.h.

◆ SerializePayload()

Aws::String Aws::ElastiCache::Model::CopySnapshotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKmsKeyId() [1/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetKmsKeyId ( const Aws::String value)
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 259 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 264 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetKmsKeyId ( const char *  value)
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 269 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotName() [1/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetSourceSnapshotName ( const Aws::String value)
inline

The name of an existing snapshot from which to make a copy.

Definition at line 56 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotName() [2/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetSourceSnapshotName ( Aws::String &&  value)
inline

The name of an existing snapshot from which to make a copy.

Definition at line 61 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotName() [3/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetSourceSnapshotName ( const char *  value)
inline

The name of an existing snapshot from which to make a copy.

Definition at line 66 of file CopySnapshotRequest.h.

◆ SetTargetBucket() [1/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetTargetBucket ( const Aws::String value)
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 178 of file CopySnapshotRequest.h.

◆ SetTargetBucket() [2/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetTargetBucket ( Aws::String &&  value)
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 191 of file CopySnapshotRequest.h.

◆ SetTargetBucket() [3/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetTargetBucket ( const char *  value)
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 204 of file CopySnapshotRequest.h.

◆ SetTargetSnapshotName() [1/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetTargetSnapshotName ( const Aws::String value)
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 103 of file CopySnapshotRequest.h.

◆ SetTargetSnapshotName() [2/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetTargetSnapshotName ( Aws::String &&  value)
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 110 of file CopySnapshotRequest.h.

◆ SetTargetSnapshotName() [3/3]

void Aws::ElastiCache::Model::CopySnapshotRequest::SetTargetSnapshotName ( const char *  value)
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 117 of file CopySnapshotRequest.h.

◆ SourceSnapshotNameHasBeenSet()

bool Aws::ElastiCache::Model::CopySnapshotRequest::SourceSnapshotNameHasBeenSet ( ) const
inline

The name of an existing snapshot from which to make a copy.

Definition at line 51 of file CopySnapshotRequest.h.

◆ TargetBucketHasBeenSet()

bool Aws::ElastiCache::Model::CopySnapshotRequest::TargetBucketHasBeenSet ( ) const
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 165 of file CopySnapshotRequest.h.

◆ TargetSnapshotNameHasBeenSet()

bool Aws::ElastiCache::Model::CopySnapshotRequest::TargetSnapshotNameHasBeenSet ( ) const
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 96 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithKmsKeyId ( const Aws::String value)
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 274 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 279 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithKmsKeyId ( const char *  value)
inline

The ID of the KMS key used to encrypt the target snapshot.

Definition at line 284 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotName() [1/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithSourceSnapshotName ( const Aws::String value)
inline

The name of an existing snapshot from which to make a copy.

Definition at line 71 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotName() [2/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithSourceSnapshotName ( Aws::String &&  value)
inline

The name of an existing snapshot from which to make a copy.

Definition at line 76 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotName() [3/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithSourceSnapshotName ( const char *  value)
inline

The name of an existing snapshot from which to make a copy.

Definition at line 81 of file CopySnapshotRequest.h.

◆ WithTargetBucket() [1/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithTargetBucket ( const Aws::String value)
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 217 of file CopySnapshotRequest.h.

◆ WithTargetBucket() [2/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithTargetBucket ( Aws::String &&  value)
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 230 of file CopySnapshotRequest.h.

◆ WithTargetBucket() [3/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithTargetBucket ( const char *  value)
inline

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Definition at line 243 of file CopySnapshotRequest.h.

◆ WithTargetSnapshotName() [1/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithTargetSnapshotName ( const Aws::String value)
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 124 of file CopySnapshotRequest.h.

◆ WithTargetSnapshotName() [2/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithTargetSnapshotName ( Aws::String &&  value)
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 131 of file CopySnapshotRequest.h.

◆ WithTargetSnapshotName() [3/3]

CopySnapshotRequest& Aws::ElastiCache::Model::CopySnapshotRequest::WithTargetSnapshotName ( const char *  value)
inline

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Definition at line 138 of file CopySnapshotRequest.h.


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