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

#include <CopyDBClusterSnapshotRequest.h>

+ Inheritance diagram for Aws::RDS::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::RDS::RDSRequest
virtual ~RDSRequest ()
 
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::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 26 of file CopyDBClusterSnapshotRequest.h.

Constructor & Destructor Documentation

◆ CopyDBClusterSnapshotRequest()

Aws::RDS::Model::CopyDBClusterSnapshotRequest::CopyDBClusterSnapshotRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

Definition at line 820 of file CopyDBClusterSnapshotRequest.h.

◆ AddTags() [2/2]

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

Definition at line 823 of file CopyDBClusterSnapshotRequest.h.

◆ CopyTagsHasBeenSet()

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

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

Definition at line 786 of file CopyDBClusterSnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::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::RDS::Model::CopyDBClusterSnapshotRequest::GetCopyTags ( ) const
inline

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

Definition at line 780 of file CopyDBClusterSnapshotRequest.h.

◆ GetKmsKeyId()

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 275 of file CopyDBClusterSnapshotRequest.h.

◆ GetPreSignedUrl()

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 479 of file CopyDBClusterSnapshotRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CopyDBClusterSnapshotRequest.h.

◆ GetSourceDBClusterSnapshotIdentifier()

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 58 of file CopyDBClusterSnapshotRequest.h.

◆ GetSourceRegion()

const Aws::String& Aws::RDS::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 829 of file CopyDBClusterSnapshotRequest.h.

◆ GetTags()

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

Definition at line 802 of file CopyDBClusterSnapshotRequest.h.

◆ GetTargetDBClusterSnapshotIdentifier()

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 181 of file CopyDBClusterSnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 298 of file CopyDBClusterSnapshotRequest.h.

◆ PreSignedUrlHasBeenSet()

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 521 of file CopyDBClusterSnapshotRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCopyTags()

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

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

Definition at line 792 of file CopyDBClusterSnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 344 of file CopyDBClusterSnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 321 of file CopyDBClusterSnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 367 of file CopyDBClusterSnapshotRequest.h.

◆ SetPreSignedUrl() [1/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 605 of file CopyDBClusterSnapshotRequest.h.

◆ SetPreSignedUrl() [2/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 563 of file CopyDBClusterSnapshotRequest.h.

◆ SetPreSignedUrl() [3/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 647 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceDBClusterSnapshotIdentifier() [1/3]

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 106 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceDBClusterSnapshotIdentifier() [2/3]

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 90 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceDBClusterSnapshotIdentifier() [3/3]

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 122 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceRegion() [1/3]

void Aws::RDS::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 844 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceRegion() [2/3]

void Aws::RDS::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 839 of file CopyDBClusterSnapshotRequest.h.

◆ SetSourceRegion() [3/3]

void Aws::RDS::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 849 of file CopyDBClusterSnapshotRequest.h.

◆ SetTags() [1/2]

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

Definition at line 811 of file CopyDBClusterSnapshotRequest.h.

◆ SetTags() [2/2]

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

Definition at line 808 of file CopyDBClusterSnapshotRequest.h.

◆ SetTargetDBClusterSnapshotIdentifier() [1/3]

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 211 of file CopyDBClusterSnapshotRequest.h.

◆ SetTargetDBClusterSnapshotIdentifier() [2/3]

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 201 of file CopyDBClusterSnapshotRequest.h.

◆ SetTargetDBClusterSnapshotIdentifier() [3/3]

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 221 of file CopyDBClusterSnapshotRequest.h.

◆ SourceDBClusterSnapshotIdentifierHasBeenSet()

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 74 of file CopyDBClusterSnapshotRequest.h.

◆ SourceRegionHasBeenSet()

bool Aws::RDS::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 834 of file CopyDBClusterSnapshotRequest.h.

◆ TagsHasBeenSet()

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

Definition at line 805 of file CopyDBClusterSnapshotRequest.h.

◆ TargetDBClusterSnapshotIdentifierHasBeenSet()

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 191 of file CopyDBClusterSnapshotRequest.h.

◆ WithCopyTags()

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

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

Definition at line 798 of file CopyDBClusterSnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 413 of file CopyDBClusterSnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 390 of file CopyDBClusterSnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

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

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

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

Definition at line 436 of file CopyDBClusterSnapshotRequest.h.

◆ WithPreSignedUrl() [1/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 731 of file CopyDBClusterSnapshotRequest.h.

◆ WithPreSignedUrl() [2/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 689 of file CopyDBClusterSnapshotRequest.h.

◆ WithPreSignedUrl() [3/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

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 Amazon Web Services Region.

Definition at line 773 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceDBClusterSnapshotIdentifier() [1/3]

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 154 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceDBClusterSnapshotIdentifier() [2/3]

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 138 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceDBClusterSnapshotIdentifier() [3/3]

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

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

Constraints:

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

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

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

Definition at line 170 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceRegion() [1/3]

CopyDBClusterSnapshotRequest& Aws::RDS::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 859 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceRegion() [2/3]

CopyDBClusterSnapshotRequest& Aws::RDS::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 854 of file CopyDBClusterSnapshotRequest.h.

◆ WithSourceRegion() [3/3]

CopyDBClusterSnapshotRequest& Aws::RDS::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 864 of file CopyDBClusterSnapshotRequest.h.

◆ WithTags() [1/2]

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

Definition at line 817 of file CopyDBClusterSnapshotRequest.h.

◆ WithTags() [2/2]

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

Definition at line 814 of file CopyDBClusterSnapshotRequest.h.

◆ WithTargetDBClusterSnapshotIdentifier() [1/3]

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 241 of file CopyDBClusterSnapshotRequest.h.

◆ WithTargetDBClusterSnapshotIdentifier() [2/3]

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 231 of file CopyDBClusterSnapshotRequest.h.

◆ WithTargetDBClusterSnapshotIdentifier() [3/3]

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

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Definition at line 251 of file CopyDBClusterSnapshotRequest.h.


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