interface IBackupVault

Language	Type name
.NET	Amazon.CDK.AWS.Backup.IBackupVault
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbackup#IBackupVault
Java	software.amazon.awscdk.services.backup.IBackupVault
Python	aws_cdk.aws_backup.IBackupVault
TypeScript (source)	aws-cdk-lib » aws_backup » IBackupVault

Implemented by BackupVault

Obtainable from BackupVault.fromBackupVaultArn(), BackupVault.fromBackupVaultName()

A backup vault.

Properties

Name	Type	Description
backupVaultArn	string	The ARN of the backup vault.
backupVaultName	string	The name of a logical container where backups are stored.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

backupVaultArn

Type: string

The ARN of the backup vault.

---

backupVaultName

Type: string

The name of a logical container where backups are stored.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they 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

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grant(grantee, ...actions)	Grant the actions defined in actions to the given grantee on this backup vault.

---

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

---

grant(grantee, ...actions)

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable
• actions string

Returns

• Grant

Grant the actions defined in actions to the given grantee on this backup vault.