Restore Cluster From Snapshot

docdbelastic_restore_cluster_from_snapshot

R Documentation

Restores an elastic cluster from a snapshot

Description

Restores an elastic cluster from a snapshot.

Usage

docdbelastic_restore_cluster_from_snapshot(clusterName, kmsKeyId,
  shardCapacity, shardInstanceCount, snapshotArn, subnetIds, tags,
  vpcSecurityGroupIds)

Arguments

clusterName

[required] The name of the elastic cluster.

kmsKeyId

The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

shardCapacity

The capacity of each shard in the new restored elastic cluster.

shardInstanceCount

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

snapshotArn

[required] The ARN identifier of the elastic cluster snapshot.

subnetIds

The Amazon EC2 subnet IDs for the elastic cluster.

tags

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

vpcSecurityGroupIds

A list of EC2 VPC security groups to associate with the elastic cluster.

Value

A list with the following syntax:

list(
  cluster = list(
    adminUserName = "string",
    authType = "PLAIN_TEXT"|"SECRET_ARN",
    backupRetentionPeriod = 123,
    clusterArn = "string",
    clusterEndpoint = "string",
    clusterName = "string",
    createTime = "string",
    kmsKeyId = "string",
    preferredBackupWindow = "string",
    preferredMaintenanceWindow = "string",
    shardCapacity = 123,
    shardCount = 123,
    shardInstanceCount = 123,
    shards = list(
      list(
        createTime = "string",
        shardId = "string",
        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"
      )
    ),
    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$restore_cluster_from_snapshot(
  clusterName = "string",
  kmsKeyId = "string",
  shardCapacity = 123,
  shardInstanceCount = 123,
  snapshotArn = "string",
  subnetIds = list(
    "string"
  ),
  tags = list(
    "string"
  ),
  vpcSecurityGroupIds = list(
    "string"
  )
)