Skip to contents

Forces a failover for a DB cluster

Source: R/rds_operations.R
rds_failover_db_cluster.Rd

Forces a failover for a DB cluster.

See https://www.paws-r-sdk.com/docs/rds_failover_db_cluster/ for full documentation.

Usage

rds_failover_db_cluster(DBClusterIdentifier, TargetDBInstanceIdentifier = NULL)

Arguments

DBClusterIdentifier

[required] 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.

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 mydbcluster-replica1.

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.