Amazon Relational Database Service
API Reference (API Version 2014-10-31)

ModifyGlobalCluster

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DeletionProtection

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when this value is set to true.

Type: Boolean

Required: No

GlobalClusterIdentifier

The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing global database cluster.

Type: String

Required: No

NewGlobalClusterIdentifier

The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

Constraints:

  • 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

Type: String

Required: No

Response Elements

The following element is returned by the service.

GlobalCluster

A data type representing an Aurora global database.

Type: GlobalCluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

GlobalClusterNotFoundFault

HTTP Status Code: 404

InvalidGlobalClusterStateFault

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: