Skip to content

CreateClusterSnapshot

Source: src/AWS/DocDBElastic/CreateClusterSnapshot.ts

Runtime binding for the CreateClusterSnapshot operation (IAM actions docdb-elastic:CreateClusterSnapshot + docdb-elastic:TagResource), scoped to one Cluster.

Takes an on-demand manual snapshot of the bound elastic cluster — e.g. a pre-migration backup from an operational Lambda. Provide the implementation with Effect.provide(AWS.DocDBElastic.CreateClusterSnapshotHttp).

const createSnapshot = yield* DocDBElastic.CreateClusterSnapshot(cluster);
const result = yield* createSnapshot({ snapshotName: "pre-migration" });
// result.snapshot.status → "CREATING"