Interface UpdateBackupScheduleOptions

Options for updating a backup schedule. Omitted fields are left unchanged.

interface UpdateBackupScheduleOptions {
    enabled?: boolean;
    frequency?: BackupScheduleFrequency;
    retentionDays?: number;
}

Properties

enabled?: boolean

false pauses the schedule and clears nextScheduledRun. true on a paused schedule runs a backup right away and recomputes the next run from now.

New cadence for the schedule.

retentionDays?: number

New retention window in days. Also re-times the expiry of backups the schedule has already produced.