Delete Global Cluster

docdb_delete_global_cluster

R Documentation

Deletes a global cluster

Description

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

This action only applies to Amazon DocumentDB clusters.

Usage

docdb_delete_global_cluster(GlobalClusterIdentifier)

Arguments

GlobalClusterIdentifier

[required] The cluster identifier of the global cluster being deleted.

Value

A list with the following syntax:

list(
  GlobalCluster = list(
    GlobalClusterIdentifier = "string",
    GlobalClusterResourceId = "string",
    GlobalClusterArn = "string",
    Status = "string",
    Engine = "string",
    EngineVersion = "string",
    DatabaseName = "string",
    StorageEncrypted = TRUE|FALSE,
    DeletionProtection = TRUE|FALSE,
    GlobalClusterMembers = list(
      list(
        DBClusterArn = "string",
        Readers = list(
          "string"
        ),
        IsWriter = TRUE|FALSE
      )
    )
  )
)

Request syntax

svc$delete_global_cluster(
  GlobalClusterIdentifier = "string"
)