AWS CDK Reference

Appearance

v2.275.0

BackupPlanRuleProps Struct ​

Properties for a BackupPlanRule.

Source
aws-backup/lib/rule.ts
Type last changed
v2.267.0 · 27 Aug 2026

Example ​

ts
declare const plan: backup.BackupPlan;
plan.addRule(new backup.BackupPlanRule({
  indexActions: [{
      resourceTypes: [backup.IndexActionResourceType.S3],
  }],
}));

Properties ​

backupVaultoptionalIBackupVaultRefbackup_vaultoptionalIBackupVaultRefbackupVaultoptionalIBackupVaultRefBackupVaultoptionalIBackupVaultRefBackupVaultoptionalIBackupVaultRef#
The backup vault where backups are.

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

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

Default: 7 days

copyActionsoptionalBackupPlanCopyActionProps[]copy_actionsoptionaltyping.List[BackupPlanCopyActionProps]copyActionsoptionalList<BackupPlanCopyActionProps>CopyActionsoptionalBackupPlanCopyActionProps[]CopyActionsoptional*[]BackupPlanCopyActionProps#
Copy operations to perform on recovery points created by this rule.

Default: no copy actions

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

Default: recovery point is never deleted

Must be greater than moveToColdStorageAfter.

enableContinuousBackupoptionalbooleanenable_continuous_backupoptionalboolenableContinuousBackupoptionalBooleanEnableContinuousBackupoptionalboolEnableContinuousBackupoptional*bool= false#
Enables continuous backup and point-in-time restores (PITR).
notes

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.

indexActionsoptionalBackupPlanIndexActionProps[]index_actionsoptionaltyping.List[BackupPlanIndexActionProps]indexActionsoptionalList<BackupPlanIndexActionProps>IndexActionsoptionalBackupPlanIndexActionProps[]IndexActionsoptional*[]BackupPlanIndexActionProps#
To help search your backups, you can enable Backup indexes by assigning index actions.

Default: no index actions.

Currently, you can only have up to a single index action per BackupRule.

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

Default: recovery point is never moved to cold storage

recoveryPointTagsoptional{ [key: string]: string }recovery_point_tagsoptionaltyping.Mapping[str, str]recoveryPointTagsoptionalMap<String, String>RecoveryPointTagsoptionalIDictionary<string, string>RecoveryPointTagsoptional*map[string]*string#
To help organize your resources, you can assign your own metadata to the resources that you create.

Default: no recovery point tags.

Each tag is a key-value pair.

ruleNameoptionalstringrule_nameoptionalstrruleNameoptionalStringRuleNameoptionalstringRuleNameoptional*string#
A display name for the backup rule.

Default: a CDK generated name

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

Default: no schedule

scheduleExpressionTimezoneoptionalTimeZoneschedule_expression_timezoneoptionalTimeZonescheduleExpressionTimezoneoptionalTimeZoneScheduleExpressionTimezoneoptionalTimeZoneScheduleExpressionTimezoneoptionalTimeZone= UTC#
The timezone in which the schedule expression is set.
startWindowoptionalDurationstart_windowoptionalDurationstartWindowoptionalDurationStartWindowoptionalDurationStartWindowoptionalDuration#
The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.

Default: 8 hours