sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Redshift/ CreateClusterSnapshot.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 `CreateClusterSnapshot` operation (IAM action
 * `redshift:CreateClusterSnapshot` on the cluster and its
 * `snapshot:{cluster}/*` ARNs).
 *
 * Takes a manual snapshot of the bound {@link Cluster} — e.g. a
 * pre-migration backup function or a scheduled snapshot-rotation job. The
 * cluster identifier is injected from the binding. Provide the
 * implementation with
 * `Effect.provide(AWS.Redshift.CreateClusterSnapshotHttp)`.
 * ### Managing Snapshots
 * **Example:** Take a Manual Snapshot
 * ```typescript
 * // init — bind the operation to the cluster
 * const createClusterSnapshot =
 *   yield* AWS.Redshift.CreateClusterSnapshot(cluster);
 *
 * // runtime
 * yield* createClusterSnapshot({
 *   SnapshotIdentifier: `pre-migration-${runId}`,
 * });
 * ```
 *
 * @binding
 */
export interface CreateClusterSnapshot extends Binding.Service<
  CreateClusterSnapshot,
  "AWS.Redshift.CreateClusterSnapshot",
  (
    cluster: Cluster,
  ) => Effect.Effect<
    (
      request: Omit<redshift.CreateClusterSnapshotMessage, "ClusterIdentifier">,
    ) => Effect.Effect<redshift.CreateClusterSnapshotResult, redshift.CreateClusterSnapshotError>
  >
> {}
export const CreateClusterSnapshot = Binding.Service<CreateClusterSnapshot>(
  "AWS.Redshift.CreateClusterSnapshot",
);