BackupPlan

class aws_cdk.aws_backup.BackupPlan(scope, id, *, backup_plan_name=None, backup_plan_rules=None, backup_vault=None)

Bases: aws_cdk.core.Resource

A backup plan.

stability :stability: experimental

__init__(scope, id, *, backup_plan_name=None, backup_plan_rules=None, backup_vault=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • backup_plan_name (Optional[str]) – The display name of the backup plan. Default: - A CDK generated name

  • backup_plan_rules (Optional[List[BackupPlanRule]]) – Rules for the backup plan. Use addRule() to add rules after instantiation. Default: - use addRule() to add rules

  • backup_vault (Optional[IBackupVault]) – The backup vault where backups are stored. Default: - use the vault defined at the rule level. If not defined a new common vault for the plan will be created

stability :stability: experimental

Return type

None

Methods

add_rule(rule)

Adds a rule to a plan.

Parameters

rule (BackupPlanRule) – the rule to add.

stability :stability: experimental

Return type

None

add_selection(id, *, resources, allow_restores=None, backup_selection_name=None, role=None)

Adds a selection to this plan.

Parameters
  • id (str) –

  • resources (List[BackupResource]) – The resources to backup. Use the helper static methods defined on BackupResource.

  • allow_restores (Optional[bool]) – Whether to automatically give restores permissions to the role that AWS Backup uses. If true, the AWSBackupServiceRolePolicyForRestores managed policy will be attached to the role. Default: false

  • backup_selection_name (Optional[str]) – The name for this selection. Default: - a CDK generated name

  • role (Optional[IRole]) – The role that AWS Backup uses to authenticate when backuping or restoring the resources. The AWSBackupServiceRolePolicyForBackup managed policy will be attached to this role. Default: - a new role will be created

stability :stability: experimental

Return type

BackupSelection

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

backup_plan_arn

The ARN of the backup plan.

stability :stability: experimental attribute: :attribute:: true

Return type

str

backup_plan_id

The identifier of the backup plan.

stability :stability: experimental

Return type

str

backup_vault

The backup vault where backups are stored if not defined at the rule level.

stability :stability: experimental

Return type

IBackupVault

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

version_id

Version Id.

stability :stability: experimental attribute: :attribute:: true

Return type

str

Static Methods

classmethod daily35_day_retention(scope, id, backup_vault=None)

Daily with 35 day retention.

Parameters

stability :stability: experimental

Return type

BackupPlan

classmethod daily_monthly1_year_retention(scope, id, backup_vault=None)

Daily and monthly with 1 year retention.

Parameters

stability :stability: experimental

Return type

BackupPlan

classmethod daily_weekly_monthly5_year_retention(scope, id, backup_vault=None)

Daily, weekly and monthly with 5 year retention.

Parameters

stability :stability: experimental

Return type

BackupPlan

classmethod daily_weekly_monthly7_year_retention(scope, id, backup_vault=None)

Daily, weekly and monthly with 7 year retention.

Parameters

stability :stability: experimental

Return type

BackupPlan

classmethod from_backup_plan_id(scope, id, backup_plan_id)

Import an existing backup plan.

Parameters
  • scope (Construct) –

  • id (str) –

  • backup_plan_id (str) –

stability :stability: experimental

Return type

IBackupPlan

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool