FailoverDBCluster

Source: src/AWS/DocDB/FailoverDBCluster.ts

Runtime binding for the FailoverDBCluster operation (IAM action rds:FailoverDBCluster).

Forces a failover of the bound DBCluster — one of the replicas is promoted to primary — for resilience testing or to move the writer to a specific instance. The cluster identifier is injected from the binding. Provide the implementation with Effect.provide(AWS.DocDB.FailoverDBClusterHttp).

Operating a Cluster

// init — bind the operation to the cluster
const failoverDBCluster = yield* AWS.DocDB.FailoverDBCluster(cluster);

// runtime — promote a specific replica
yield* failoverDBCluster({
  TargetDBInstanceIdentifier: replicaId,
});