Skip to content

Copy Cluster Snapshot

docdbelastic_copy_cluster_snapshot R Documentation

Copies a snapshot of an elastic cluster

Description

Copies a snapshot of an elastic cluster.

Usage

docdbelastic_copy_cluster_snapshot(copyTags, kmsKeyId, snapshotArn,
  tags, targetSnapshotName)

Arguments

copyTags

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

kmsKeyId

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

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

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

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

snapshotArn

[required] The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

tags

The tags to be assigned to the elastic cluster snapshot.

targetSnapshotName

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

Constraints:

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

  • The first character must be a letter.

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

Example: elastic-cluster-snapshot-5

Value

A list with the following syntax: 

list(
  snapshot = list(
    adminUserName = "string",
    clusterArn = "string",
    clusterCreationTime = "string",
    kmsKeyId = "string",
    snapshotArn = "string",
    snapshotCreationTime = "string",
    snapshotName = "string",
    snapshotType = "MANUAL"|"AUTOMATED",
    status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"VPC_ENDPOINT_LIMIT_EXCEEDED"|"IP_ADDRESS_LIMIT_EXCEEDED"|"INVALID_SECURITY_GROUP_ID"|"INVALID_SUBNET_ID"|"INACCESSIBLE_ENCRYPTION_CREDS"|"INACCESSIBLE_SECRET_ARN"|"INACCESSIBLE_VPC_ENDPOINT"|"INCOMPATIBLE_NETWORK"|"MERGING"|"MODIFYING"|"SPLITTING"|"COPYING"|"STARTING"|"STOPPING"|"STOPPED",
    subnetIds = list(
      "string"
    ),
    vpcSecurityGroupIds = list(
      "string"
    )
  )
)

Request syntax

svc$copy_cluster_snapshot(
  copyTags = TRUE|FALSE,
  kmsKeyId = "string",
  snapshotArn = "string",
  tags = list(
    "string"
  ),
  targetSnapshotName = "string"
)