sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CloudHSMV2/ DeleteBackup.ts

import type * as cloudhsm from "@distilled.cloud/aws/cloudhsm-v2";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for the `DeleteBackup` operation (IAM action
 * `cloudhsm:DeleteBackup`).
 *
 * Marks a CloudHSM backup for deletion — it enters `PENDING_DELETION` and
 * can still be recovered with `RestoreBackup` for 7 days. Pair with
 * `DescribeBackups` to build a backup-pruning job. Provide the
 * implementation with `Effect.provide(AWS.CloudHSMV2.DeleteBackupHttp)`.
 * ### Managing Backups
 * **Example:** Prune A Backup
 * ```typescript
 * const deleteBackup = yield* AWS.CloudHSMV2.DeleteBackup();
 *
 * const deleted = yield* deleteBackup({ BackupId: backupId });
 * // deleted.Backup?.BackupState === "PENDING_DELETION"
 * ```
 *
 * @binding
 */
export interface DeleteBackup extends Binding.Service<
  DeleteBackup,
  "AWS.CloudHSMV2.DeleteBackup",
  () => Effect.Effect<
    (
      request: cloudhsm.DeleteBackupRequest,
    ) => Effect.Effect<cloudhsm.DeleteBackupResponse, cloudhsm.DeleteBackupError>
  >
> {}
export const DeleteBackup = Binding.Service<DeleteBackup>("AWS.CloudHSMV2.DeleteBackup");