/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace RDS { namespace Model { /** *

See Also:

AWS * API Reference

*/ class AWS_RDS_API CopyDBSnapshotRequest : public RDSRequest { public: CopyDBSnapshotRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CopyDBSnapshot"; } Aws::String SerializePayload() const override; protected: void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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 *

*/ inline const Aws::String& GetSourceDBSnapshotIdentifier() const{ return m_sourceDBSnapshotIdentifier; } /** *

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 *

*/ inline bool SourceDBSnapshotIdentifierHasBeenSet() const { return m_sourceDBSnapshotIdentifierHasBeenSet; } /** *

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 *

*/ inline void SetSourceDBSnapshotIdentifier(const Aws::String& value) { m_sourceDBSnapshotIdentifierHasBeenSet = true; m_sourceDBSnapshotIdentifier = value; } /** *

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 *

*/ inline void SetSourceDBSnapshotIdentifier(Aws::String&& value) { m_sourceDBSnapshotIdentifierHasBeenSet = true; m_sourceDBSnapshotIdentifier = std::move(value); } /** *

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 *

*/ inline void SetSourceDBSnapshotIdentifier(const char* value) { m_sourceDBSnapshotIdentifierHasBeenSet = true; m_sourceDBSnapshotIdentifier.assign(value); } /** *

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 *

*/ inline CopyDBSnapshotRequest& WithSourceDBSnapshotIdentifier(const Aws::String& value) { SetSourceDBSnapshotIdentifier(value); return *this;} /** *

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 *

*/ inline CopyDBSnapshotRequest& WithSourceDBSnapshotIdentifier(Aws::String&& value) { SetSourceDBSnapshotIdentifier(std::move(value)); return *this;} /** *

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 *

*/ inline CopyDBSnapshotRequest& WithSourceDBSnapshotIdentifier(const char* value) { SetSourceDBSnapshotIdentifier(value); return *this;} /** *

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

*/ inline const Aws::String& GetTargetDBSnapshotIdentifier() const{ return m_targetDBSnapshotIdentifier; } /** *

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

*/ inline bool TargetDBSnapshotIdentifierHasBeenSet() const { return m_targetDBSnapshotIdentifierHasBeenSet; } /** *

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

*/ inline void SetTargetDBSnapshotIdentifier(const Aws::String& value) { m_targetDBSnapshotIdentifierHasBeenSet = true; m_targetDBSnapshotIdentifier = value; } /** *

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

*/ inline void SetTargetDBSnapshotIdentifier(Aws::String&& value) { m_targetDBSnapshotIdentifierHasBeenSet = true; m_targetDBSnapshotIdentifier = std::move(value); } /** *

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

*/ inline void SetTargetDBSnapshotIdentifier(const char* value) { m_targetDBSnapshotIdentifierHasBeenSet = true; m_targetDBSnapshotIdentifier.assign(value); } /** *

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

*/ inline CopyDBSnapshotRequest& WithTargetDBSnapshotIdentifier(const Aws::String& value) { SetTargetDBSnapshotIdentifier(value); return *this;} /** *

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

*/ inline CopyDBSnapshotRequest& WithTargetDBSnapshotIdentifier(Aws::String&& value) { SetTargetDBSnapshotIdentifier(std::move(value)); return *this;} /** *

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

*/ inline CopyDBSnapshotRequest& WithTargetDBSnapshotIdentifier(const char* value) { SetTargetDBSnapshotIdentifier(value); return *this;} /** *

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.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

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.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

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.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

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.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

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.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

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.

*/ inline CopyDBSnapshotRequest& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

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.

*/ inline CopyDBSnapshotRequest& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

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.

*/ inline CopyDBSnapshotRequest& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} inline const Aws::Vector& GetTags() const{ return m_tags; } inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } inline CopyDBSnapshotRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} inline CopyDBSnapshotRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} inline CopyDBSnapshotRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } inline CopyDBSnapshotRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

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.

*/ inline bool GetCopyTags() const{ return m_copyTags; } /** *

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.

*/ inline bool CopyTagsHasBeenSet() const { return m_copyTagsHasBeenSet; } /** *

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.

*/ inline void SetCopyTags(bool value) { m_copyTagsHasBeenSet = true; m_copyTags = value; } /** *

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.

*/ inline CopyDBSnapshotRequest& WithCopyTags(bool value) { SetCopyTags(value); return *this;} /** *

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.

*/ inline const Aws::String& GetPreSignedUrl() const{ return m_preSignedUrl; } /** *

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.

*/ inline bool PreSignedUrlHasBeenSet() const { return m_preSignedUrlHasBeenSet; } /** *

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.

*/ inline void SetPreSignedUrl(const Aws::String& value) { m_preSignedUrlHasBeenSet = true; m_preSignedUrl = value; } /** *

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.

*/ inline void SetPreSignedUrl(Aws::String&& value) { m_preSignedUrlHasBeenSet = true; m_preSignedUrl = std::move(value); } /** *

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.

*/ inline void SetPreSignedUrl(const char* value) { m_preSignedUrlHasBeenSet = true; m_preSignedUrl.assign(value); } /** *

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.

*/ inline CopyDBSnapshotRequest& WithPreSignedUrl(const Aws::String& value) { SetPreSignedUrl(value); return *this;} /** *

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.

*/ inline CopyDBSnapshotRequest& WithPreSignedUrl(Aws::String&& value) { SetPreSignedUrl(std::move(value)); return *this;} /** *

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.

*/ inline CopyDBSnapshotRequest& WithPreSignedUrl(const char* value) { SetPreSignedUrl(value); return *this;} /** *

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.

*/ inline const Aws::String& GetOptionGroupName() const{ return m_optionGroupName; } /** *

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.

*/ inline bool OptionGroupNameHasBeenSet() const { return m_optionGroupNameHasBeenSet; } /** *

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.

*/ inline void SetOptionGroupName(const Aws::String& value) { m_optionGroupNameHasBeenSet = true; m_optionGroupName = value; } /** *

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.

*/ inline void SetOptionGroupName(Aws::String&& value) { m_optionGroupNameHasBeenSet = true; m_optionGroupName = std::move(value); } /** *

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.

*/ inline void SetOptionGroupName(const char* value) { m_optionGroupNameHasBeenSet = true; m_optionGroupName.assign(value); } /** *

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.

*/ inline CopyDBSnapshotRequest& WithOptionGroupName(const Aws::String& value) { SetOptionGroupName(value); return *this;} /** *

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.

*/ inline CopyDBSnapshotRequest& WithOptionGroupName(Aws::String&& value) { SetOptionGroupName(std::move(value)); return *this;} /** *

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.

*/ inline CopyDBSnapshotRequest& WithOptionGroupName(const char* value) { SetOptionGroupName(value); return *this;} private: Aws::String m_sourceDBSnapshotIdentifier; bool m_sourceDBSnapshotIdentifierHasBeenSet; Aws::String m_targetDBSnapshotIdentifier; bool m_targetDBSnapshotIdentifierHasBeenSet; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet; Aws::Vector m_tags; bool m_tagsHasBeenSet; bool m_copyTags; bool m_copyTagsHasBeenSet; Aws::String m_preSignedUrl; bool m_preSignedUrlHasBeenSet; Aws::String m_optionGroupName; bool m_optionGroupNameHasBeenSet; }; } // namespace Model } // namespace RDS } // namespace Aws