docdb_modify_global_cluster: Modify a setting for an Amazon DocumentDB global cluster

View source: R/docdb_operations.R

docdb_modify_global_clusterR Documentation

Modify a setting for an Amazon DocumentDB global cluster

Description

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

See https://www.paws-r-sdk.com/docs/docdb_modify_global_cluster/ for full documentation.

Usage

docdb_modify_global_cluster(
  GlobalClusterIdentifier,
  NewGlobalClusterIdentifier = NULL,
  DeletionProtection = NULL
)

Arguments

GlobalClusterIdentifier

[required] The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster.

NewGlobalClusterIdentifier

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • Must contain from 1 to 63 letters, numbers, or hyphens

    The first character must be a letter

    Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

DeletionProtection

Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.


paws.database documentation built on Sept. 12, 2023, 1:21 a.m.