Skip to content
v2.275.0

BackupPlanProps Struct ​

Properties for a BackupPlan.

Example ​

ts
const plan = new backup.BackupPlan(this, 'Plan', {
  windowsVss: true,
});

Properties ​

backupPlanNameoptionalstringbackup_plan_nameoptionalstrbackupPlanNameoptionalStringBackupPlanNameoptionalstringBackupPlanNameoptional*string#
The display name of the backup plan.

Default: A CDK generated name

backupPlanRulesoptionalBackupPlanRule[]backup_plan_rulesoptionaltyping.List[BackupPlanRule]backupPlanRulesoptionalList<BackupPlanRule>BackupPlanRulesoptionalBackupPlanRule[]BackupPlanRulesoptional*[]BackupPlanRule#
Rules for the backup plan.

Default: use addRule() to add rules

Use addRule() to add rules after instantiation.

backupVaultoptionalIBackupVaultRefbackup_vaultoptionalIBackupVaultRefbackupVaultoptionalIBackupVaultRefBackupVaultoptionalIBackupVaultRefBackupVaultoptionalIBackupVaultRef#
The backup vault where backups are stored.

Default: use the vault defined at the rule level. If not defined a new common vault for the plan will be created

windowsVssoptionalbooleanwindows_vssoptionalboolwindowsVssoptionalBooleanWindowsVssoptionalboolWindowsVssoptional*bool= false#
Enable Windows VSS backup.