sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Redshift/ PauseCluster.ts

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

/**
 * Runtime binding for the `PauseCluster` operation (IAM action
 * `redshift:PauseCluster`).
 *
 * Pauses the bound {@link Cluster} (compute billing stops, storage
 * persists) — e.g. a scheduled ops function that parks the warehouse
 * overnight to save cost. The cluster identifier is injected from the
 * binding. Provide the implementation with
 * `Effect.provide(AWS.Redshift.PauseClusterHttp)`.
 * ### Operating a Cluster
 * **Example:** Pause the Warehouse Overnight
 * ```typescript
 * // init — bind the operation to the cluster
 * const pauseCluster = yield* AWS.Redshift.PauseCluster(cluster);
 *
 * // runtime
 * yield* pauseCluster();
 * ```
 *
 * @binding
 */
export interface PauseCluster extends Binding.Service<
  PauseCluster,
  "AWS.Redshift.PauseCluster",
  (
    cluster: Cluster,
  ) => Effect.Effect<() => Effect.Effect<redshift.PauseClusterResult, redshift.PauseClusterError>>
> {}
export const PauseCluster = Binding.Service<PauseCluster>("AWS.Redshift.PauseCluster");