Copy Db Cluster Snapshot
rds_copy_db_cluster_snapshot | R Documentation |
Copies a snapshot of a DB cluster¶
Description¶
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name
(ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web
Services Region. In that case, the Amazon Web Services Region where you
call the copy_db_cluster_snapshot
operation is the destination Amazon
Web Services Region for the encrypted DB cluster snapshot to be copied
to. To copy an encrypted DB cluster snapshot from another Amazon Web
Services Region, you must provide the following values:
-
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target
DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Usage¶
rds_copy_db_cluster_snapshot(SourceDBClusterSnapshotIdentifier,
TargetDBClusterSnapshotIdentifier, KmsKeyId, PreSignedUrl, CopyTags,
Tags)
Arguments¶
SourceDBClusterSnapshotIdentifier |
[required] The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive. You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another. Constraints:
Example: |
TargetDBClusterSnapshotIdentifier |
[required] The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive. Constraints:
Example: |
KmsKeyId |
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key. If you copy an encrypted DB cluster snapshot from your Amazon Web
Services account, you can specify a value for If you copy an encrypted DB cluster snapshot that is shared from
another Amazon Web Services account, then you must specify a value for
To copy an encrypted DB cluster snapshot to another Amazon Web
Services Region, you must set If you copy an unencrypted DB cluster snapshot and specify a value
for the |
PreSignedUrl |
When you are copying a DB cluster snapshot from one Amazon Web
Services GovCloud (US) Region to another, the URL that contains a
Signature Version 4 signed request for the
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions. The presigned URL must be a valid request for the
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can
specify |
CopyTags |
Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied. |
Tags |
Value¶
A list with the following syntax:
list(
DBClusterSnapshot = list(
AvailabilityZones = list(
"string"
),
DBClusterSnapshotIdentifier = "string",
DBClusterIdentifier = "string",
SnapshotCreateTime = as.POSIXct(
"2015-01-01"
),
Engine = "string",
EngineMode = "string",
AllocatedStorage = 123,
Status = "string",
Port = 123,
VpcId = "string",
ClusterCreateTime = as.POSIXct(
"2015-01-01"
),
MasterUsername = "string",
EngineVersion = "string",
LicenseModel = "string",
SnapshotType = "string",
PercentProgress = 123,
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
DBClusterSnapshotArn = "string",
SourceDBClusterSnapshotArn = "string",
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
TagList = list(
list(
Key = "string",
Value = "string"
)
),
DBSystemId = "string",
StorageType = "string",
DbClusterResourceId = "string",
StorageThroughput = 123
)
)
Request syntax¶
svc$copy_db_cluster_snapshot(
SourceDBClusterSnapshotIdentifier = "string",
TargetDBClusterSnapshotIdentifier = "string",
KmsKeyId = "string",
PreSignedUrl = "string",
CopyTags = TRUE|FALSE,
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
Examples¶
## Not run:
# The following example copies an automated snapshot of a DB cluster to a
# new DB cluster snapshot.
svc$copy_db_cluster_snapshot(
SourceDBClusterSnapshotIdentifier = "rds:sample-cluster-2016-09-14-10-38",
TargetDBClusterSnapshotIdentifier = "cluster-snapshot-copy-1"
)
## End(Not run)