AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

BackupPlan

A backup plan.

Import

import { BackupPlan } from 'aws-cdk-lib/aws-backup';

Or use the module namespace:

import * as backup from 'aws-cdk-lib/aws-backup';
// backup.BackupPlan

Properties

Configuration passed to the constructor as BackupPlanProps.

backupPlanNameOptional
string

The display name of the backup plan.

Default: - A CDK generated name

backupPlanRulesOptional
BackupPlanRule[]

Rules for the backup plan. Use `addRule()` to add rules after instantiation.

Default: - use `addRule()` to add rules

backupVaultOptional
IBackupVaultRef

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

windowsVssOptional
boolean

Enable Windows VSS backup.

Default: false

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter