sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ MemoryDB/ FailoverShard.ts

import type * as memorydb from "@distilled.cloud/aws/memorydb";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Cluster } from "./Cluster.ts";

/**
 * Runtime binding for the `FailoverShard` operation (IAM action
 * `memorydb:FailoverShard`), scoped to one {@link Cluster}.
 *
 * Fails over a shard's primary node to a replica — designed for testing how
 * your application behaves during a MemoryDB failover (chaos testing), not
 * as a production remediation tool. Provide the implementation with
 * `Effect.provide(AWS.MemoryDB.FailoverShardHttp)`.
 * ### Testing Failover
 * **Example:** Fail Over a Shard
 * ```typescript
 * const failoverShard = yield* MemoryDB.FailoverShard(cluster);
 *
 * const result = yield* failoverShard({ ShardName: "0001" });
 * // result.Cluster.Status → "updating"
 * ```
 *
 * @binding
 */
export interface FailoverShard extends Binding.Service<
  FailoverShard,
  "AWS.MemoryDB.FailoverShard",
  (
    cluster: Cluster,
  ) => Effect.Effect<
    (
      request: Omit<memorydb.FailoverShardRequest, "ClusterName">,
    ) => Effect.Effect<memorydb.FailoverShardResponse, memorydb.FailoverShardError>
  >
> {}
export const FailoverShard = Binding.Service<FailoverShard>("AWS.MemoryDB.FailoverShard");