aws-cdk-lib.aws_backup.IBackupPlan

interface IBackupPlan

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

Implemented by BackupPlan

Obtainable from BackupPlan.fromBackupPlanId()

A backup plan.

Properties

NameTypeDescription
backupPlanIdstringThe identifier of the backup plan.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

backupPlanId

Type: string

The identifier of the backup plan.


env

Type: ResourceEnvironment

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

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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