SwitchoverGlobalCluster
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- GlobalClusterIdentifier
-
The identifier of the Amazon DocumentDB global database cluster to switch over. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster. This parameter isn’t case-sensitive.
Constraints:
-
Must match the identifier of an existing global cluster (Amazon DocumentDB global database).
-
Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*Required: Yes
-
- TargetDbClusterIdentifier
-
The identifier of the secondary Amazon DocumentDB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its AWS region.
Constraints:
-
Must match the identifier of an existing secondary cluster.
-
Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*Required: Yes
-
Response Elements
The following element is returned by the service.
- GlobalCluster
-
A data type representing an Amazon DocumentDB global cluster.
Type: GlobalCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterNotFoundFault
-
DBClusterIdentifierdoesn't refer to an existing cluster.HTTP Status Code: 404
- GlobalClusterNotFoundFault
-
The
GlobalClusterIdentifierdoesn't refer to an existing global cluster.HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The cluster isn't in a valid state.
HTTP Status Code: 400
- InvalidGlobalClusterStateFault
-
The requested operation can't be performed while the cluster is in this state.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
