BackupPlanProps

class aws_cdk.aws_backup.BackupPlanProps(*, backup_plan_name=None, backup_plan_rules=None, backup_vault=None, windows_vss=None)

Bases: object

Properties for a BackupPlan.

Parameters
  • backup_plan_name (Optional[str]) – The display name of the backup plan. Default: - A CDK generated name

  • backup_plan_rules (Optional[Sequence[BackupPlanRule]]) – Rules for the backup plan. Use addRule() to add rules after instantiation. Default: - use addRule() to add rules

  • backup_vault (Optional[IBackupVault]) – 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

  • windows_vss (Optional[bool]) – Enable Windows VSS backup. Default: false

ExampleMetadata

infused

Example:

plan = backup.BackupPlan(self, "Plan",
    windows_vss=True
)

Attributes

backup_plan_name

The display name of the backup plan.

Default
  • A CDK generated name

Return type

Optional[str]

backup_plan_rules

Rules for the backup plan.

Use addRule() to add rules after instantiation.

Default
  • use addRule() to add rules

Return type

Optional[List[BackupPlanRule]]

backup_vault

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

Return type

Optional[IBackupVault]

windows_vss

Enable Windows VSS backup.

Default

false

See

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

Return type

Optional[bool]