GET

/#Action=ModifyGlobalCluster

http://rds.{region}.amazonaws.com/#Action=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. <note> This action only applies to Amazon DocumentDB clusters. </note>

Access Token Required: API Key

Query Params

GlobalClusterIdentifierstringrequired

The identifier for the global cluster being modified. This parameter isn't case-sensitive. Constraints: <ul> <li> Must match the identifier of an existing global cluster. </li> </ul>

NewGlobalClusterIdentifierstring

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string. <ul> <li> 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 </li> </ul> Example: <code>my-cluster2</code>

DeletionProtectionboolean

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

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://rds.{region}.amazonaws.com/#Action=ModifyGlobalCluster' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}