Delete Db Cluster Snapshot

docdb_delete_db_cluster_snapshot

R Documentation

Deletes a cluster snapshot

Description

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The cluster snapshot must be in the available state to be deleted.

Usage

docdb_delete_db_cluster_snapshot(DBClusterSnapshotIdentifier)

Arguments

DBClusterSnapshotIdentifier

[required] The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

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",
    Status = "string",
    Port = 123,
    VpcId = "string",
    ClusterCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    MasterUsername = "string",
    EngineVersion = "string",
    SnapshotType = "string",
    PercentProgress = 123,
    StorageEncrypted = TRUE|FALSE,
    KmsKeyId = "string",
    DBClusterSnapshotArn = "string",
    SourceDBClusterSnapshotArn = "string",
    StorageType = "string"
  )
)

Request syntax

svc$delete_db_cluster_snapshot(
  DBClusterSnapshotIdentifier = "string"
)