Skip to contents

Forces a failover for a cluster

Source: R/docdb_operations.R
docdb_failover_db_cluster.Rd

Forces a failover for a cluster.

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

Usage

docdb_failover_db_cluster(
  DBClusterIdentifier = NULL,
  TargetDBInstanceIdentifier = NULL
)

Arguments

DBClusterIdentifier

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

TargetDBInstanceIdentifier

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.