Delete Db Cluster Snapshot

rds_delete_db_cluster_snapshot

R Documentation

Deletes a DB cluster snapshot¶

Description¶

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

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

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Usage¶

rds_delete_db_cluster_snapshot(DBClusterSnapshotIdentifier)

Arguments¶

DBClusterSnapshotIdentifier

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

Constraints: Must be the name of an existing DB 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",
    EngineMode = "string",
    AllocatedStorage = 123,
    Status = "string",
    Port = 123,
    VpcId = "string",
    ClusterCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    MasterUsername = "string",
    EngineVersion = "string",
    LicenseModel = "string",
    SnapshotType = "string",
    PercentProgress = 123,
    StorageEncrypted = TRUE|FALSE,
    KmsKeyId = "string",
    DBClusterSnapshotArn = "string",
    SourceDBClusterSnapshotArn = "string",
    IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    DBSystemId = "string",
    StorageType = "string",
    DbClusterResourceId = "string",
    StorageThroughput = 123
  )
)

Request syntax¶

svc$delete_db_cluster_snapshot(
  DBClusterSnapshotIdentifier = "string"
)

Examples¶

## Not run: 
# This example deletes the specified DB cluster snapshot.
svc$delete_db_cluster_snapshot(
  DBClusterSnapshotIdentifier = "mydbclustersnapshot"
)

## End(Not run)