BackupPlan

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

Bases: Resource

A backup plan.

ExampleMetadata:

infused

Example:

# Daily, weekly and monthly with 5 year retention
plan = backup.BackupPlan.daily_weekly_monthly5_year_retention(self, "Plan")
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[Sequence[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

  • windows_vss (Optional[bool]) – Enable Windows VSS backup. Default: false

Methods

add_rule(rule)

Adds a rule to a plan.

Parameters:

rule (BackupPlanRule) – the rule to add.

Return type:

None

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

Adds a selection to this plan.

Parameters:

  • id (str) –

  • resources (Sequence[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

  • disable_default_backup_policy (Optional[bool]) – Whether to disable automatically assigning default backup permissions to the role that AWS Backup uses. If false, the AWSBackupServiceRolePolicyForBackup managed policy will be attached to the role. Default: false

  • 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 unless disableDefaultBackupPolicy is set to true. Default: - a new role will be created

Return type:

BackupSelection

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

backup_plan_arn

The ARN of the backup plan.

Attribute:

true

backup_plan_id

The identifier of the backup plan.

backup_vault

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

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The tree node.

stack

The stack in which this resource is defined.

version_id

Version Id.

Attribute:

true

Static Methods

classmethod daily35_day_retention(scope, id, backup_vault=None)

Daily with 35 day retention.

Parameters:
Return type:

BackupPlan

classmethod daily_monthly1_year_retention(scope, id, backup_vault=None)

Daily and monthly with 1 year retention.

Parameters:
Return type:

BackupPlan

classmethod daily_weekly_monthly5_year_retention(scope, id, backup_vault=None)

Daily, weekly and monthly with 5 year retention.

Parameters:
Return type:

BackupPlan

classmethod daily_weekly_monthly7_year_retention(scope, id, backup_vault=None)

Daily, weekly and monthly with 7 year retention.

Parameters:
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) –

Return type:

IBackupPlan

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool