interface BackupPlanProps

Language	Type name
.NET	Amazon.CDK.AWS.Backup.BackupPlanProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbackup#BackupPlanProps
Java	software.amazon.awscdk.services.backup.BackupPlanProps
Python	aws_cdk.aws_backup.BackupPlanProps
TypeScript (source)	aws-cdk-lib » aws_backup » BackupPlanProps

Properties for a BackupPlan.

Example

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

Properties

Name	Type	Description
backupPlanName?	string	The display name of the backup plan.
backupPlanRules?	BackupPlanRule[]	Rules for the backup plan.
backupVault?	IBackupVault	The backup vault where backups are stored.
windowsVss?	boolean	Enable Windows VSS backup.

---

backupPlanName?

Type: string (optional, default: A CDK generated name)

The display name of the backup plan.

---

backupPlanRules?

Type: BackupPlanRule[] (optional, default: use addRule() to add rules)

Rules for the backup plan.

Use addRule() to add rules after instantiation.

---

backupVault?

Type: IBackupVault (optional, default: use the vault defined at the rule level. If not defined a new common vault for the plan will be created)

The backup vault where backups are stored.

---

windowsVss?

Type: boolean (optional, default: false)

Enable Windows VSS backup.

See also: https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html