Container for the parameters to the FailoverDBCluster operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.RDS.AmazonRDSRequest
Amazon.RDS.Model.FailoverDBClusterRequest
Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z
Syntax
public class FailoverDBClusterRequest : AmazonRDSRequest IAmazonWebServiceRequest
The FailoverDBClusterRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
FailoverDBClusterRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DBClusterIdentifier | System.String |
Gets and sets the property DBClusterIdentifier. The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive. Constraints:
|
|
|
TargetDBInstanceIdentifier | System.String |
Gets and sets the property TargetDBInstanceIdentifier. 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 This setting isn't supported for RDS for MySQL Multi-AZ DB clusters. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5