sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ DocDBElastic/ DeleteClusterSnapshot.ts

import type * as docdbelastic from "@distilled.cloud/aws/docdb-elastic";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for the `DeleteClusterSnapshot` operation (IAM action
 * `docdb-elastic:DeleteClusterSnapshot`).
 *
 * Deletes a manual elastic-cluster snapshot by ARN — e.g. from a Lambda that
 * prunes on-demand backups past a retention horizon. Provide the
 * implementation with
 * `Effect.provide(AWS.DocDBElastic.DeleteClusterSnapshotHttp)`.
 * ### Managing Snapshots
 * **Example:** Prune an Old Snapshot
 * ```typescript
 * const deleteSnapshot = yield* DocDBElastic.DeleteClusterSnapshot();
 *
 * const result = yield* deleteSnapshot({ snapshotArn });
 * // result.snapshot.status → "DELETING"
 * ```
 *
 * @binding
 */
export interface DeleteClusterSnapshot extends Binding.Service<
  DeleteClusterSnapshot,
  "AWS.DocDBElastic.DeleteClusterSnapshot",
  () => Effect.Effect<
    (
      request: docdbelastic.DeleteClusterSnapshotInput,
    ) => Effect.Effect<
      docdbelastic.DeleteClusterSnapshotOutput,
      docdbelastic.DeleteClusterSnapshotError
    >
  >
> {}
export const DeleteClusterSnapshot = Binding.Service<DeleteClusterSnapshot>(
  "AWS.DocDBElastic.DeleteClusterSnapshot",
);