class BackupPlanRule

Language	Type name
.NET	Amazon.CDK.AWS.Backup.BackupPlanRule
Java	software.amazon.awscdk.services.backup.BackupPlanRule
Python	aws_cdk.aws_backup.BackupPlanRule
TypeScript (source)	@aws-cdk/aws-backup » BackupPlanRule

A backup plan rule.

Example

declare const plan: backup.BackupPlan;
plan.addRule(backup.BackupPlanRule.daily());
plan.addRule(backup.BackupPlanRule.weekly());

Initializer

new BackupPlanRule(props: BackupPlanRuleProps)

Parameters

• props BackupPlanRuleProps — Rule properties.

Properties

Name	Type	Description
props	BackupPlanRuleProps	Properties of BackupPlanRule.

---

props

Type: BackupPlanRuleProps

Properties of BackupPlanRule.

Methods

Name	Description
static daily(backupVault?)	Daily with 35 days retention.
static monthly1Year(backupVault?)	Monthly 1 year retention, move to cold storage after 1 month.
static monthly5Year(backupVault?)	Monthly 5 year retention, move to cold storage after 3 months.
static monthly7Year(backupVault?)	Monthly 7 year retention, move to cold storage after 3 months.
static weekly(backupVault?)	Weekly with 3 months retention.

---

static daily(backupVault?)

public static daily(backupVault?: IBackupVault): BackupPlanRule

Parameters

• backupVault IBackupVault

Returns

• BackupPlanRule

Daily with 35 days retention.

---

static monthly1Year(backupVault?)

public static monthly1Year(backupVault?: IBackupVault): BackupPlanRule

Parameters

• backupVault IBackupVault

Returns

• BackupPlanRule

Monthly 1 year retention, move to cold storage after 1 month.

---

static monthly5Year(backupVault?)

public static monthly5Year(backupVault?: IBackupVault): BackupPlanRule

Parameters

• backupVault IBackupVault

Returns

• BackupPlanRule

Monthly 5 year retention, move to cold storage after 3 months.

---

static monthly7Year(backupVault?)

public static monthly7Year(backupVault?: IBackupVault): BackupPlanRule

Parameters

• backupVault IBackupVault

Returns

• BackupPlanRule

Monthly 7 year retention, move to cold storage after 3 months.

---

static weekly(backupVault?)

public static weekly(backupVault?: IBackupVault): BackupPlanRule

Parameters

• backupVault IBackupVault

Returns

• BackupPlanRule

Weekly with 3 months retention.