Smaws_Client_DocDB.FailoverGlobalClusterPromotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.
Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
val error_to_string :
[ Smaws_Lib.Protocols.AwsQuery.error
| `DBClusterNotFoundFault of Types.db_cluster_not_found_fault
| `GlobalClusterNotFoundFault of Types.global_cluster_not_found_fault
| `InvalidDBClusterStateFault of Types.invalid_db_cluster_state_fault
| `InvalidGlobalClusterStateFault of Types.invalid_global_cluster_state_fault ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.failover_global_cluster_message ->
(Types.failover_global_cluster_result,
[> Smaws_Lib.Protocols.AwsQuery.error
| `DBClusterNotFoundFault of Types.db_cluster_not_found_fault
| `GlobalClusterNotFoundFault of Types.global_cluster_not_found_fault
| `InvalidDBClusterStateFault of Types.invalid_db_cluster_state_fault
| `InvalidGlobalClusterStateFault of
Types.invalid_global_cluster_state_fault ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.failover_global_cluster_message ->
(Types.failover_global_cluster_result Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsQuery.error
| `DBClusterNotFoundFault of Types.db_cluster_not_found_fault
| `GlobalClusterNotFoundFault of Types.global_cluster_not_found_fault
| `InvalidDBClusterStateFault of Types.invalid_db_cluster_state_fault
| `InvalidGlobalClusterStateFault of
Types.invalid_global_cluster_state_fault ]
* Smaws_Lib.Response.metadata)
Stdlib.result