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

#include <CopyDBSnapshotRequest.h>

+ Inheritance diagram for Aws::RDS::Model::CopyDBSnapshotRequest:

Public Member Functions

 CopyDBSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::String & GetSourceDBSnapshotIdentifier () const
 
bool SourceDBSnapshotIdentifierHasBeenSet () const
 
void SetSourceDBSnapshotIdentifier (const Aws::String &value)
 
void SetSourceDBSnapshotIdentifier (Aws::String &&value)
 
void SetSourceDBSnapshotIdentifier (const char *value)
 
CopyDBSnapshotRequest & WithSourceDBSnapshotIdentifier (const Aws::String &value)
 
CopyDBSnapshotRequest & WithSourceDBSnapshotIdentifier (Aws::String &&value)
 
CopyDBSnapshotRequest & WithSourceDBSnapshotIdentifier (const char *value)
 
const Aws::String & GetTargetDBSnapshotIdentifier () const
 
bool TargetDBSnapshotIdentifierHasBeenSet () const
 
void SetTargetDBSnapshotIdentifier (const Aws::String &value)
 
void SetTargetDBSnapshotIdentifier (Aws::String &&value)
 
void SetTargetDBSnapshotIdentifier (const char *value)
 
CopyDBSnapshotRequest & WithTargetDBSnapshotIdentifier (const Aws::String &value)
 
CopyDBSnapshotRequest & WithTargetDBSnapshotIdentifier (Aws::String &&value)
 
CopyDBSnapshotRequest & WithTargetDBSnapshotIdentifier (const char *value)
 
const Aws::String & GetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CopyDBSnapshotRequest & WithKmsKeyId (const Aws::String &value)
 
CopyDBSnapshotRequest & WithKmsKeyId (Aws::String &&value)
 
CopyDBSnapshotRequest & WithKmsKeyId (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CopyDBSnapshotRequest & WithTags (const Aws::Vector< Tag > &value)
 
CopyDBSnapshotRequest & WithTags (Aws::Vector< Tag > &&value)
 
CopyDBSnapshotRequest & AddTags (const Tag &value)
 
CopyDBSnapshotRequest & AddTags (Tag &&value)
 
bool GetCopyTags () const
 
bool CopyTagsHasBeenSet () const
 
void SetCopyTags (bool value)
 
CopyDBSnapshotRequest & WithCopyTags (bool value)
 
const Aws::String & GetPreSignedUrl () const
 
bool PreSignedUrlHasBeenSet () const
 
void SetPreSignedUrl (const Aws::String &value)
 
void SetPreSignedUrl (Aws::String &&value)
 
void SetPreSignedUrl (const char *value)
 
CopyDBSnapshotRequest & WithPreSignedUrl (const Aws::String &value)
 
CopyDBSnapshotRequest & WithPreSignedUrl (Aws::String &&value)
 
CopyDBSnapshotRequest & WithPreSignedUrl (const char *value)
 
const Aws::String & GetOptionGroupName () const
 
bool OptionGroupNameHasBeenSet () const
 
void SetOptionGroupName (const Aws::String &value)
 
void SetOptionGroupName (Aws::String &&value)
 
void SetOptionGroupName (const char *value)
 
CopyDBSnapshotRequest & WithOptionGroupName (const Aws::String &value)
 
CopyDBSnapshotRequest & WithOptionGroupName (Aws::String &&value)
 
CopyDBSnapshotRequest & WithOptionGroupName (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::IOStream > GetBody () 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 RequestSignedHandler & GetRequestSignedHandler () const
 
const Aws::IOStreamFactory & GetResponseStreamFactory () 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::DataReceivedEventHandler & GetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const
 
virtual const RequestRetryHandler & GetRequestRetryHandler () 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 CopyDBSnapshotRequest.h.

Constructor & Destructor Documentation

◆ CopyDBSnapshotRequest()

Aws::RDS::Model::CopyDBSnapshotRequest::CopyDBSnapshotRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

Definition at line 426 of file CopyDBSnapshotRequest.h.

◆ AddTags() [2/2]

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

Definition at line 429 of file CopyDBSnapshotRequest.h.

◆ CopyTagsHasBeenSet()

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

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

Definition at line 442 of file CopyDBSnapshotRequest.h.

◆ DumpBodyToUrl()

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

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

Definition at line 436 of file CopyDBSnapshotRequest.h.

◆ GetKmsKeyId()

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 285 of file CopyDBSnapshotRequest.h.

◆ GetOptionGroupName()

const Aws::String& Aws::RDS::Model::CopyDBSnapshotRequest::GetOptionGroupName ( ) const
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 812 of file CopyDBSnapshotRequest.h.

◆ GetPreSignedUrl()

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 498 of file CopyDBSnapshotRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CopyDBSnapshotRequest.h.

◆ GetSourceDBSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::CopyDBSnapshotRequest::GetSourceDBSnapshotIdentifier ( ) const
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 61 of file CopyDBSnapshotRequest.h.

◆ GetTags()

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

Definition at line 408 of file CopyDBSnapshotRequest.h.

◆ GetTargetDBSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::CopyDBSnapshotRequest::GetTargetDBSnapshotIdentifier ( ) const
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 204 of file CopyDBSnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 302 of file CopyDBSnapshotRequest.h.

◆ OptionGroupNameHasBeenSet()

bool Aws::RDS::Model::CopyDBSnapshotRequest::OptionGroupNameHasBeenSet ( ) const
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 824 of file CopyDBSnapshotRequest.h.

◆ PreSignedUrlHasBeenSet()

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 541 of file CopyDBSnapshotRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCopyTags()

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

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

Definition at line 448 of file CopyDBSnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 319 of file CopyDBSnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 336 of file CopyDBSnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 353 of file CopyDBSnapshotRequest.h.

◆ SetOptionGroupName() [1/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetOptionGroupName ( const Aws::String &  value)
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 836 of file CopyDBSnapshotRequest.h.

◆ SetOptionGroupName() [2/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetOptionGroupName ( Aws::String &&  value)
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 848 of file CopyDBSnapshotRequest.h.

◆ SetOptionGroupName() [3/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetOptionGroupName ( const char *  value)
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 860 of file CopyDBSnapshotRequest.h.

◆ SetPreSignedUrl() [1/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 584 of file CopyDBSnapshotRequest.h.

◆ SetPreSignedUrl() [2/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 627 of file CopyDBSnapshotRequest.h.

◆ SetPreSignedUrl() [3/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 670 of file CopyDBSnapshotRequest.h.

◆ SetSourceDBSnapshotIdentifier() [1/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetSourceDBSnapshotIdentifier ( const Aws::String &  value)
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 99 of file CopyDBSnapshotRequest.h.

◆ SetSourceDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetSourceDBSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 118 of file CopyDBSnapshotRequest.h.

◆ SetSourceDBSnapshotIdentifier() [3/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetSourceDBSnapshotIdentifier ( const char *  value)
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 137 of file CopyDBSnapshotRequest.h.

◆ SetTags() [1/2]

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

Definition at line 414 of file CopyDBSnapshotRequest.h.

◆ SetTags() [2/2]

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

Definition at line 417 of file CopyDBSnapshotRequest.h.

◆ SetTargetDBSnapshotIdentifier() [1/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetTargetDBSnapshotIdentifier ( const Aws::String &  value)
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 222 of file CopyDBSnapshotRequest.h.

◆ SetTargetDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetTargetDBSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 231 of file CopyDBSnapshotRequest.h.

◆ SetTargetDBSnapshotIdentifier() [3/3]

void Aws::RDS::Model::CopyDBSnapshotRequest::SetTargetDBSnapshotIdentifier ( const char *  value)
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 240 of file CopyDBSnapshotRequest.h.

◆ SourceDBSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::CopyDBSnapshotRequest::SourceDBSnapshotIdentifierHasBeenSet ( ) const
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 80 of file CopyDBSnapshotRequest.h.

◆ TagsHasBeenSet()

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

Definition at line 411 of file CopyDBSnapshotRequest.h.

◆ TargetDBSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::CopyDBSnapshotRequest::TargetDBSnapshotIdentifierHasBeenSet ( ) const
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 213 of file CopyDBSnapshotRequest.h.

◆ WithCopyTags()

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

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

Definition at line 454 of file CopyDBSnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 370 of file CopyDBSnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 387 of file CopyDBSnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

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

The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

Definition at line 404 of file CopyDBSnapshotRequest.h.

◆ WithOptionGroupName() [1/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithOptionGroupName ( const Aws::String &  value)
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 872 of file CopyDBSnapshotRequest.h.

◆ WithOptionGroupName() [2/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithOptionGroupName ( Aws::String &&  value)
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 884 of file CopyDBSnapshotRequest.h.

◆ WithOptionGroupName() [3/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithOptionGroupName ( const char *  value)
inline

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Definition at line 896 of file CopyDBSnapshotRequest.h.

◆ WithPreSignedUrl() [1/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 713 of file CopyDBSnapshotRequest.h.

◆ WithPreSignedUrl() [2/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 756 of file CopyDBSnapshotRequest.h.

◆ WithPreSignedUrl() [3/3]

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

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

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

  • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

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

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

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or –source-region for the AWS 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 AWS Region.

Definition at line 799 of file CopyDBSnapshotRequest.h.

◆ WithSourceDBSnapshotIdentifier() [1/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithSourceDBSnapshotIdentifier ( const Aws::String &  value)
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 156 of file CopyDBSnapshotRequest.h.

◆ WithSourceDBSnapshotIdentifier() [2/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithSourceDBSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 175 of file CopyDBSnapshotRequest.h.

◆ WithSourceDBSnapshotIdentifier() [3/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithSourceDBSnapshotIdentifier ( const char *  value)
inline

The identifier for the source DB snapshot.

If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

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

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Definition at line 194 of file CopyDBSnapshotRequest.h.

◆ WithTags() [1/2]

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

Definition at line 420 of file CopyDBSnapshotRequest.h.

◆ WithTags() [2/2]

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

Definition at line 423 of file CopyDBSnapshotRequest.h.

◆ WithTargetDBSnapshotIdentifier() [1/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithTargetDBSnapshotIdentifier ( const Aws::String &  value)
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 249 of file CopyDBSnapshotRequest.h.

◆ WithTargetDBSnapshotIdentifier() [2/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithTargetDBSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 258 of file CopyDBSnapshotRequest.h.

◆ WithTargetDBSnapshotIdentifier() [3/3]

CopyDBSnapshotRequest& Aws::RDS::Model::CopyDBSnapshotRequest::WithTargetDBSnapshotIdentifier ( const char *  value)
inline

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

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

Example: my-db-snapshot

Definition at line 267 of file CopyDBSnapshotRequest.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.13
Privacy | Site terms | Cookie preferences