import type * as docdb from "@distilled.cloud/aws/docdb";
import type * as Effect from "effect/Effect";
import * as Binding from "../../Binding.ts";
import type { DBCluster } from "./DBCluster.ts";

/**
 * Runtime binding for the `FailoverDBCluster` operation (IAM action
 * `rds:FailoverDBCluster`).
 *
 * Forces a failover of the bound {@link 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
 * **Example:** Force a Failover
 * ```typescript
 * // init — bind the operation to the cluster
 * const failoverDBCluster = yield* AWS.DocDB.FailoverDBCluster(cluster);
 *
 * // runtime — promote a specific replica
 * yield* failoverDBCluster({
 *   TargetDBInstanceIdentifier: replicaId,
 * });
 * ```
 *
 * @binding
 */
export interface FailoverDBCluster extends Binding.Service<
  FailoverDBCluster,
  "AWS.DocDB.FailoverDBCluster",
  (
    cluster: DBCluster,
  ) => Effect.Effect<
    (
      request?: Omit<docdb.FailoverDBClusterMessage, "DBClusterIdentifier">,
    ) => Effect.Effect<
      docdb.FailoverDBClusterResult,
      docdb.FailoverDBClusterError
    >
  >
> {}
export const FailoverDBCluster = Binding.Service<FailoverDBCluster>(
  "AWS.DocDB.FailoverDBCluster",
);