ModifyGlobalCluster
Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AllowMajorVersionUpgrade
-
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades if you specify a value for the
EngineVersionparameter that is a different major version than the DB cluster's current version.If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.
Type: Boolean
Required: No
- DeletionProtection
-
Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.
Type: Boolean
Required: No
- EngineVersion
-
The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless
ApplyImmediatelyis enabled.To list all of the available Neptune engine versions, use the following command:
Type: String
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
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*Required: Yes
- NewGlobalClusterIdentifier
-
A new cluster identifier to assign to the global database. 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-cluster2Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*Required: No
-
Response Elements
The following element is returned by the service.
- GlobalCluster
-
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
Type: GlobalCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- GlobalClusterNotFoundFault
-
The
GlobalClusterIdentifierdoesn't refer to an existing global database cluster.HTTP Status Code: 404
- InvalidGlobalClusterStateFault
-
The global cluster is in an invalid state and can't perform the requested operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
