Skip to content

Remove From Global Cluster

docdb_remove_from_global_cluster R Documentation

Detaches an Amazon DocumentDB secondary cluster from a global cluster

Description

Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.

This action only applies to Amazon DocumentDB clusters.

Usage

docdb_remove_from_global_cluster(GlobalClusterIdentifier,
  DbClusterIdentifier)

Arguments

GlobalClusterIdentifier

[required] The cluster identifier to detach from the Amazon DocumentDB global cluster.

DbClusterIdentifier

[required] The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

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$remove_from_global_cluster(
  GlobalClusterIdentifier = "string",
  DbClusterIdentifier = "string"
)