Module Values_1.FailoverDBClusterResultSource

Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds. An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails. To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Sourcetype failoverDBClusterResult = {
  1. dBCluster : Values_0.DBCluster.t option;
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. failoverDBClusterResult : failoverDBClusterResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `DBClusterNotFoundFault of Values_0.DBClusterNotFoundFault.t
  2. | `InvalidDBClusterStateFault of Values_0.InvalidDBClusterStateFault.t
  3. | `InvalidDBInstanceStateFault of Values_0.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 bool | `Enum of string | `Integer of int | `List of [> `String of string | `Structure of (string * [> `Boolean of bool | `Integer of int | `List of [> `String of string ] list | `String of string ]) list ] list | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Boolean of bool | `Double of float | `Enum of string | `Integer of int | `String of string | `Structure of (string * [> `Enum of string | `List of [> `String of string ] list | `String of string | `Timestamp of string ]) list | `Timestamp of string ]) list | `Timestamp of string ]) 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