interface BackupPlanRuleProps

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

Properties for a BackupPlanRule.

Example

declare const plan: backup.BackupPlan;
declare const secondaryVault: backup.BackupVault;
plan.addRule(new backup.BackupPlanRule({
  copyActions: [{
    destinationBackupVault: secondaryVault,
    moveToColdStorageAfter: Duration.days(30),
    deleteAfter: Duration.days(120),
  }]
}));

Properties

Name	Type	Description
backupVault?	IBackupVault	The backup vault where backups are.
completionWindow?	Duration	The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.
copyActions?	BackupPlanCopyActionProps[]	Copy operations to perform on recovery points created by this rule.
deleteAfter?	Duration	Specifies the duration after creation that a recovery point is deleted.
enableContinuousBackup?	boolean	Enables continuous backup and point-in-time restores (PITR).
moveToColdStorageAfter?	Duration	Specifies the duration after creation that a recovery point is moved to cold storage.
recoveryPointTags?	{ [string]: string }	To help organize your resources, you can assign your own metadata to the resources that you create.
ruleName?	string	A display name for the backup rule.
scheduleExpression?	Schedule	A CRON expression specifying when AWS Backup initiates a backup job.
startWindow?	Duration	The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.

---

backupVault?

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

The backup vault where backups are.

---

completionWindow?

Type: Duration (optional, default: 7 days)

The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.

---

copyActions?

Type: BackupPlanCopyActionProps[] (optional, default: no copy actions)

Copy operations to perform on recovery points created by this rule.

---

deleteAfter?

Type: Duration (optional, default: recovery point is never deleted)

Specifies the duration after creation that a recovery point is deleted.

Must be greater than moveToColdStorageAfter.

---

enableContinuousBackup?

Type: boolean (optional, default: false)

Enables continuous backup and point-in-time restores (PITR).

Property deleteAfter defines the retention period for the backup. It is mandatory if PITR is enabled. If no value is specified, the retention period is set to 35 days which is the maximum retention period supported by PITR.

Property moveToColdStorageAfter must not be specified because PITR does not support this option.

---

moveToColdStorageAfter?

Type: Duration (optional, default: recovery point is never moved to cold storage)

Specifies the duration after creation that a recovery point is moved to cold storage.

---

recoveryPointTags?

Type: { [string]: string } (optional, default: no recovery point tags.)

To help organize your resources, you can assign your own metadata to the resources that you create.

Each tag is a key-value pair.

---

ruleName?

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

A display name for the backup rule.

---

scheduleExpression?

Type: Schedule (optional, default: no schedule)

A CRON expression specifying when AWS Backup initiates a backup job.

---

startWindow?

Type: Duration (optional, default: 8 hours)

The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.