Skip to content

Create Cluster Snapshot

docdbelastic_create_cluster_snapshot R Documentation

Creates a snapshot of an elastic cluster

Description

Creates a snapshot of an elastic cluster.

Usage

docdbelastic_create_cluster_snapshot(clusterArn, snapshotName, tags)

Arguments

clusterArn

[required] The ARN identifier of the elastic cluster of which you want to create a snapshot.

snapshotName

[required] The name of the new elastic cluster snapshot.

tags

The tags to be assigned to the new elastic cluster snapshot.

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$create_cluster_snapshot(
  clusterArn = "string",
  snapshotName = "string",
  tags = list(
    "string"
  )
)