failover_db_cluster¶
Operation¶
async
¶
failover_db_cluster(input: FailoverDBClusterInput, plugins: list[Plugin] | None = None) -> FailoverDBClusterOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
FailoverDBClusterInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
FailoverDBClusterOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing DB cluster.
class-attribute
instance-attribute
¶
target_db_instance_identifier: str | None = ...
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ
readable standby in the DB cluster, for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for FailoverDBClusterOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response
element in the operations CreateDBCluster, DeleteDBCluster,
DescribeDBClusters, FailoverDBCluster, ModifyDBCluster,
PromoteReadReplicaDBCluster, RestoreDBClusterFromS3,
RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime,
StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element
in the operations CreateDBCluster, DeleteDBCluster,
DescribeDBClusters, FailoverDBCluster, ModifyDBCluster,
RebootDBCluster, RestoreDBClusterFromSnapshot, and
RestoreDBClusterToPointInTime.
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 deployments with two readable standby DB instances in the Amazon RDS User Guide.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.