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

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

/**
 * Runtime binding for the `CopyDBClusterSnapshot` operation (IAM action
 * `rds:CopyDBClusterSnapshot`).
 *
 * Copies a Neptune cluster snapshot — e.g. archive a nightly snapshot under
 * a retention prefix, or copy it for cross-region disaster recovery. Provide
 * the implementation with
 * `Effect.provide(AWS.Neptune.CopyDBClusterSnapshotHttp)`.
 * ### Managing Snapshots
 * **Example:** Archive a Snapshot
 * ```typescript
 * const copyDBClusterSnapshot = yield* AWS.Neptune.CopyDBClusterSnapshot();
 *
 * yield* copyDBClusterSnapshot({
 *   SourceDBClusterSnapshotIdentifier: snapshotId,
 *   TargetDBClusterSnapshotIdentifier: `${snapshotId}-archive`,
 * });
 * ```
 *
 * @binding
 */
export interface CopyDBClusterSnapshot extends Binding.Service<
  CopyDBClusterSnapshot,
  "AWS.Neptune.CopyDBClusterSnapshot",
  () => Effect.Effect<
    (
      request?: neptune.CopyDBClusterSnapshotMessage,
    ) => Effect.Effect<neptune.CopyDBClusterSnapshotResult, neptune.CopyDBClusterSnapshotError>
  >
> {}
export const CopyDBClusterSnapshot = Binding.Service<CopyDBClusterSnapshot>(
  "AWS.Neptune.CopyDBClusterSnapshot",
);