BackupPlanRuleProps

class aws_cdk.aws_backup.BackupPlanRuleProps(*, backup_vault=None, completion_window=None, delete_after=None, move_to_cold_storage_after=None, rule_name=None, schedule_expression=None, start_window=None)

Bases: object

(experimental) Properties for a BackupPlanRule.

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

  • completion_window (Optional[Duration]) – (experimental) The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. Default: - 8 hours

  • delete_after (Optional[Duration]) – (experimental) Specifies the duration after creation that a recovery point is deleted. Must be greater than moveToColdStorageAfter. Default: - recovery point is never deleted

  • move_to_cold_storage_after (Optional[Duration]) – (experimental) Specifies the duration after creation that a recovery point is moved to cold storage. Default: - recovery point is never moved to cold storage

  • rule_name (Optional[str]) – (experimental) A display name for the backup rule. Default: - a CDK generated name

  • schedule_expression (Optional[Schedule]) – (experimental) A CRON expression specifying when AWS Backup initiates a backup job. Default: - no schedule

  • start_window (Optional[Duration]) – (experimental) The duration after a backup is scheduled before a job is canceled if it doesn’t start successfully. Default: - 8 hours

Stability

experimental

Attributes

backup_vault

(experimental) 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

Stability

experimental

Return type

Optional[IBackupVault]

completion_window

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

Default
  • 8 hours

Stability

experimental

Return type

Optional[Duration]

delete_after

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

Must be greater than moveToColdStorageAfter.

Default
  • recovery point is never deleted

Stability

experimental

Return type

Optional[Duration]

move_to_cold_storage_after

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

Default
  • recovery point is never moved to cold storage

Stability

experimental

Return type

Optional[Duration]

rule_name

(experimental) A display name for the backup rule.

Default
  • a CDK generated name

Stability

experimental

Return type

Optional[str]

schedule_expression

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

Default
  • no schedule

Stability

experimental

Return type

Optional[Schedule]

start_window

(experimental) The duration after a backup is scheduled before a job is canceled if it doesn’t start successfully.

Default
  • 8 hours

Stability

experimental

Return type

Optional[Duration]