aws-cdk-lib.aws_backup.BackupPlanRule

class BackupPlanRule

LanguageType name
.NETAmazon.CDK.AWS.Backup.BackupPlanRule
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbackup#BackupPlanRule
Javasoftware.amazon.awscdk.services.backup.BackupPlanRule
Pythonaws_cdk.aws_backup.BackupPlanRule
TypeScript (source)aws-cdk-lib » aws_backup » BackupPlanRule

A backup plan rule.

Example

declare const plan: backup.BackupPlan;
plan.addRule(new backup.BackupPlanRule({
  enableContinuousBackup: true,
  deleteAfter: Duration.days(14),
}));

Initializer

new BackupPlanRule(props: BackupPlanRuleProps)

Parameters

  • props BackupPlanRuleProps — Rule properties.

Properties

NameTypeDescription
propsBackupPlanRulePropsProperties of BackupPlanRule.

props

Type: BackupPlanRuleProps

Properties of BackupPlanRule.

Methods

NameDescription
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.