Type Alias BackupCollectionArgs<C>

The arguments required to create and restore backups.

type BackupCollectionArgs<
    C extends BackupConfigCreate
    | BackupConfigRestore = never,
> = {
    backend: Backend;
    backupId: string;
    config?: C;
    waitForCompletion?: boolean;
}

Type Parameters

C extends BackupConfigCreate | BackupConfigRestore = never

Index

Properties

backend backupId config? waitForCompletion?

Properties

backend

backend: Backend

The backend to use for the backup.

backupId

backupId: string

The ID of the backup.

`Optional`config

config?: C

The configuration options for the backup.

`Optional`waitForCompletion

waitForCompletion?: boolean

The collections to include in the backup.