docdb_delete_db_cluster_snapshot: Deletes a cluster snapshot

Description Usage Arguments Value Request syntax

View source: R/docdb_operations.R

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

1
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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"
  )
)

Request syntax

1
2
3
svc$delete_db_cluster_snapshot(
  DBClusterSnapshotIdentifier = "string"
)

paws.database documentation built on March 9, 2021, 5:11 p.m.