sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Neptune/ StartDBCluster.ts

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

/**
 * Runtime binding for the `StartDBCluster` operation (IAM action
 * `rds:StartDBCluster`).
 *
 * Starts the bound {@link DBCluster} after it was stopped — e.g. an ops
 * function that wakes a development cluster on a schedule. The cluster
 * identifier is injected from the binding. Provide the implementation with
 * `Effect.provide(AWS.Neptune.StartDBClusterHttp)`.
 * ### Operating a Cluster
 * **Example:** Start a Stopped Cluster
 * ```typescript
 * // init — bind the operation to the cluster
 * const startDBCluster = yield* AWS.Neptune.StartDBCluster(cluster);
 *
 * // runtime
 * yield* startDBCluster();
 * ```
 *
 * @binding
 */
export interface StartDBCluster extends Binding.Service<
  StartDBCluster,
  "AWS.Neptune.StartDBCluster",
  (
    cluster: DBCluster,
  ) => Effect.Effect<() => Effect.Effect<neptune.StartDBClusterResult, neptune.StartDBClusterError>>
> {}
export const StartDBCluster = Binding.Service<StartDBCluster>("AWS.Neptune.StartDBCluster");