AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::DocDB::Model::CopyDBClusterSnapshotRequest Class Reference

#include <CopyDBClusterSnapshotRequest.h>

+ Inheritance diagram for Aws::DocDB::Model::CopyDBClusterSnapshotRequest:

Public Member Functions

 CopyDBClusterSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetSourceDBClusterSnapshotIdentifier () const
 
bool SourceDBClusterSnapshotIdentifierHasBeenSet () const
 
void SetSourceDBClusterSnapshotIdentifier (const Aws::String &value)
 
void SetSourceDBClusterSnapshotIdentifier (Aws::String &&value)
 
void SetSourceDBClusterSnapshotIdentifier (const char *value)
 
CopyDBClusterSnapshotRequestWithSourceDBClusterSnapshotIdentifier (const Aws::String &value)
 
CopyDBClusterSnapshotRequestWithSourceDBClusterSnapshotIdentifier (Aws::String &&value)
 
CopyDBClusterSnapshotRequestWithSourceDBClusterSnapshotIdentifier (const char *value)
 
const Aws::StringGetTargetDBClusterSnapshotIdentifier () const
 
bool TargetDBClusterSnapshotIdentifierHasBeenSet () const
 
void SetTargetDBClusterSnapshotIdentifier (const Aws::String &value)
 
void SetTargetDBClusterSnapshotIdentifier (Aws::String &&value)
 
void SetTargetDBClusterSnapshotIdentifier (const char *value)
 
CopyDBClusterSnapshotRequestWithTargetDBClusterSnapshotIdentifier (const Aws::String &value)
 
CopyDBClusterSnapshotRequestWithTargetDBClusterSnapshotIdentifier (Aws::String &&value)
 
CopyDBClusterSnapshotRequestWithTargetDBClusterSnapshotIdentifier (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)
 
CopyDBClusterSnapshotRequestWithKmsKeyId (const Aws::String &value)
 
CopyDBClusterSnapshotRequestWithKmsKeyId (Aws::String &&value)
 
CopyDBClusterSnapshotRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetPreSignedUrl () const
 
bool PreSignedUrlHasBeenSet () const
 
void SetPreSignedUrl (const Aws::String &value)
 
void SetPreSignedUrl (Aws::String &&value)
 
void SetPreSignedUrl (const char *value)
 
CopyDBClusterSnapshotRequestWithPreSignedUrl (const Aws::String &value)
 
CopyDBClusterSnapshotRequestWithPreSignedUrl (Aws::String &&value)
 
CopyDBClusterSnapshotRequestWithPreSignedUrl (const char *value)
 
bool GetCopyTags () const
 
bool CopyTagsHasBeenSet () const
 
void SetCopyTags (bool value)
 
CopyDBClusterSnapshotRequestWithCopyTags (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CopyDBClusterSnapshotRequestWithTags (const Aws::Vector< Tag > &value)
 
CopyDBClusterSnapshotRequestWithTags (Aws::Vector< Tag > &&value)
 
CopyDBClusterSnapshotRequestAddTags (const Tag &value)
 
CopyDBClusterSnapshotRequestAddTags (Tag &&value)
 
const Aws::StringGetSourceRegion () const
 
bool SourceRegionHasBeenSet () const
 
void SetSourceRegion (const Aws::String &value)
 
void SetSourceRegion (Aws::String &&value)
 
void SetSourceRegion (const char *value)
 
CopyDBClusterSnapshotRequestWithSourceRegion (const Aws::String &value)
 
CopyDBClusterSnapshotRequestWithSourceRegion (Aws::String &&value)
 
CopyDBClusterSnapshotRequestWithSourceRegion (const char *value)
 
- Public Member Functions inherited from Aws::DocDB::DocDBRequest
virtual ~DocDBRequest ()
 
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::DocDB::DocDBRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input to CopyDBClusterSnapshot.

See Also:

AWS API Reference

Definition at line 27 of file CopyDBClusterSnapshotRequest.h.

Constructor & Destructor Documentation

◆ CopyDBClusterSnapshotRequest()

Aws::DocDB::Model::CopyDBClusterSnapshotRequest::CopyDBClusterSnapshotRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::AddTags ( const Tag value)
inline

The tags to be assigned to the cluster snapshot.

Definition at line 655 of file CopyDBClusterSnapshotRequest.h.

◆ AddTags() [2/2]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::AddTags ( Tag &&  value)
inline

The tags to be assigned to the cluster snapshot.

Definition at line 660 of file CopyDBClusterSnapshotRequest.h.

◆ CopyTagsHasBeenSet()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::CopyTagsHasBeenSet ( ) const
inline

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

Definition at line 605 of file CopyDBClusterSnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::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.

◆ GetCopyTags()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetCopyTags ( ) const
inline

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

Definition at line 598 of file CopyDBClusterSnapshotRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetKmsKeyId ( ) const
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 232 of file CopyDBClusterSnapshotRequest.h.

◆ GetPreSignedUrl()

const Aws::String& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetPreSignedUrl ( ) const
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 394 of file CopyDBClusterSnapshotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CopyDBClusterSnapshotRequest.h.

◆ GetSourceDBClusterSnapshotIdentifier()

const Aws::String& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetSourceDBClusterSnapshotIdentifier ( ) const
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 54 of file CopyDBClusterSnapshotRequest.h.

◆ GetSourceRegion()

const Aws::String& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetSourceRegion ( ) const
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 666 of file CopyDBClusterSnapshotRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetTags ( ) const
inline

The tags to be assigned to the cluster snapshot.

Definition at line 625 of file CopyDBClusterSnapshotRequest.h.

◆ GetTargetDBClusterSnapshotIdentifier()

const Aws::String& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::GetTargetDBClusterSnapshotIdentifier ( ) const
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 142 of file CopyDBClusterSnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::KmsKeyIdHasBeenSet ( ) const
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 251 of file CopyDBClusterSnapshotRequest.h.

◆ PreSignedUrlHasBeenSet()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::PreSignedUrlHasBeenSet ( ) const
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 422 of file CopyDBClusterSnapshotRequest.h.

◆ SerializePayload()

Aws::String Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCopyTags()

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetCopyTags ( bool  value)
inline

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

Definition at line 612 of file CopyDBClusterSnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 289 of file CopyDBClusterSnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetKmsKeyId ( const Aws::String value)
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 270 of file CopyDBClusterSnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetKmsKeyId ( const char *  value)
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 308 of file CopyDBClusterSnapshotRequest.h.

◆ SetPreSignedUrl() [1/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetPreSignedUrl ( Aws::String &&  value)
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 478 of file CopyDBClusterSnapshotRequest.h.

◆ SetPreSignedUrl() [2/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetPreSignedUrl ( const Aws::String value)
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 450 of file CopyDBClusterSnapshotRequest.h.

◆ SetPreSignedUrl() [3/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetPreSignedUrl ( const char *  value)
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 506 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceDBClusterSnapshotIdentifier() [1/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetSourceDBClusterSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 87 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceDBClusterSnapshotIdentifier() [2/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetSourceDBClusterSnapshotIdentifier ( const Aws::String value)
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 76 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceDBClusterSnapshotIdentifier() [3/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetSourceDBClusterSnapshotIdentifier ( const char *  value)
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 98 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceRegion() [1/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetSourceRegion ( Aws::String &&  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 681 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceRegion() [2/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetSourceRegion ( const Aws::String value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 676 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceRegion() [3/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetSourceRegion ( const char *  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 686 of file CopyDBClusterSnapshotRequest.h.

◆ SetTags() [1/2]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The tags to be assigned to the cluster snapshot.

Definition at line 640 of file CopyDBClusterSnapshotRequest.h.

◆ SetTags() [2/2]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The tags to be assigned to the cluster snapshot.

Definition at line 635 of file CopyDBClusterSnapshotRequest.h.

◆ SetTargetDBClusterSnapshotIdentifier() [1/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetTargetDBClusterSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 172 of file CopyDBClusterSnapshotRequest.h.

◆ SetTargetDBClusterSnapshotIdentifier() [2/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetTargetDBClusterSnapshotIdentifier ( const Aws::String value)
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 162 of file CopyDBClusterSnapshotRequest.h.

◆ SetTargetDBClusterSnapshotIdentifier() [3/3]

void Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SetTargetDBClusterSnapshotIdentifier ( const char *  value)
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 182 of file CopyDBClusterSnapshotRequest.h.

◆ SourceDBClusterSnapshotIdentifierHasBeenSet()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SourceDBClusterSnapshotIdentifierHasBeenSet ( ) const
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 65 of file CopyDBClusterSnapshotRequest.h.

◆ SourceRegionHasBeenSet()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::SourceRegionHasBeenSet ( ) const
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 671 of file CopyDBClusterSnapshotRequest.h.

◆ TagsHasBeenSet()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::TagsHasBeenSet ( ) const
inline

The tags to be assigned to the cluster snapshot.

Definition at line 630 of file CopyDBClusterSnapshotRequest.h.

◆ TargetDBClusterSnapshotIdentifierHasBeenSet()

bool Aws::DocDB::Model::CopyDBClusterSnapshotRequest::TargetDBClusterSnapshotIdentifierHasBeenSet ( ) const
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 152 of file CopyDBClusterSnapshotRequest.h.

◆ WithCopyTags()

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithCopyTags ( bool  value)
inline

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

Definition at line 619 of file CopyDBClusterSnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 346 of file CopyDBClusterSnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithKmsKeyId ( const Aws::String value)
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 327 of file CopyDBClusterSnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithKmsKeyId ( const char *  value)
inline

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Definition at line 365 of file CopyDBClusterSnapshotRequest.h.

◆ WithPreSignedUrl() [1/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithPreSignedUrl ( Aws::String &&  value)
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 562 of file CopyDBClusterSnapshotRequest.h.

◆ WithPreSignedUrl() [2/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithPreSignedUrl ( const Aws::String value)
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 534 of file CopyDBClusterSnapshotRequest.h.

◆ WithPreSignedUrl() [3/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithPreSignedUrl ( const char *  value)
inline

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Definition at line 590 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceDBClusterSnapshotIdentifier() [1/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithSourceDBClusterSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 120 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceDBClusterSnapshotIdentifier() [2/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithSourceDBClusterSnapshotIdentifier ( const Aws::String value)
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 109 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceDBClusterSnapshotIdentifier() [3/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithSourceDBClusterSnapshotIdentifier ( const char *  value)
inline

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Definition at line 131 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceRegion() [1/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithSourceRegion ( Aws::String &&  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 696 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceRegion() [2/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithSourceRegion ( const Aws::String value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 691 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceRegion() [3/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithSourceRegion ( const char *  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 701 of file CopyDBClusterSnapshotRequest.h.

◆ WithTags() [1/2]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The tags to be assigned to the cluster snapshot.

Definition at line 650 of file CopyDBClusterSnapshotRequest.h.

◆ WithTags() [2/2]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The tags to be assigned to the cluster snapshot.

Definition at line 645 of file CopyDBClusterSnapshotRequest.h.

◆ WithTargetDBClusterSnapshotIdentifier() [1/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithTargetDBClusterSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 202 of file CopyDBClusterSnapshotRequest.h.

◆ WithTargetDBClusterSnapshotIdentifier() [2/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithTargetDBClusterSnapshotIdentifier ( const Aws::String value)
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 192 of file CopyDBClusterSnapshotRequest.h.

◆ WithTargetDBClusterSnapshotIdentifier() [3/3]

CopyDBClusterSnapshotRequest& Aws::DocDB::Model::CopyDBClusterSnapshotRequest::WithTargetDBClusterSnapshotIdentifier ( const char *  value)
inline

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Definition at line 212 of file CopyDBClusterSnapshotRequest.h.


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