Skip to content

Get Cluster Snapshot

docdbelastic_get_cluster_snapshot R Documentation

Returns information about a specific elastic cluster snapshot

Description

Returns information about a specific elastic cluster snapshot

Usage

docdbelastic_get_cluster_snapshot(snapshotArn)

Arguments

snapshotArn

[required] The ARN identifier of the 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$get_cluster_snapshot(
  snapshotArn = "string"
)