Module Values.FailoverDBClusterResultSource

Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

Sourcetype failoverDBClusterResult = {
  1. dBCluster : DBCluster.t option;
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. failoverDBClusterResult : failoverDBClusterResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `DBClusterNotFoundFault of DBClusterNotFoundFault.t
  2. | `InvalidDBClusterStateFault of InvalidDBClusterStateFault.t
  3. | `InvalidDBInstanceStateFault of InvalidDBInstanceStateFault.t
  4. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?dBCluster:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DBClusterNotFoundFault of unit | `InvalidDBClusterStateFault of unit | `InvalidDBInstanceStateFault of unit | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `DBClusterNotFoundFault of unit | `InvalidDBClusterStateFault of unit | `InvalidDBInstanceStateFault of unit | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Structure of (string * [> `Boolean of Boolean.t | `Integer of IntegerOptional.t | `List of [> `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of IntegerOptional.t | `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Double of DoubleOptional.t | `String of String_.t ]) list | `Timestamp of TStamp.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t