Skip to content

/AWS1/CL_DOD=>MODIFYGLOBALCLUSTER()

About ModifyGlobalCluster

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.

This action only applies to Amazon DocumentDB clusters.

Method Signature

IMPORTING

Required arguments:

IV_GLOBALCLUSTERIDENTIFIER TYPE /AWS1/DODGLOBALCLUSTERID /AWS1/DODGLOBALCLUSTERID

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

Constraints:

  • Must match the identifier of an existing global cluster.

Optional arguments:

IV_NEWGLOBALCLUSTERID TYPE /AWS1/DODGLOBALCLUSTERID /AWS1/DODGLOBALCLUSTERID

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

IV_DELETIONPROTECTION TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_DODMODIFYGLBCLUSTRSLT /AWS1/CL_DODMODIFYGLBCLUSTRSLT