AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

BackupVault

A backup vault.

Import

import { BackupVault } from 'aws-cdk-lib/aws-backup';

Or use the module namespace:

import * as backup from 'aws-cdk-lib/aws-backup';
// backup.BackupVault

Properties

Configuration passed to the constructor as BackupVaultProps.

accessPolicyOptional
PolicyDocument

A resource-based policy that is used to manage access permissions on the backup vault.

Default: - access is not restricted

backupVaultNameOptional
string

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.

Default: - A CDK generated name

blockRecoveryPointDeletionOptional
boolean

Whether to add statements to the vault access policy that prevents anyone from deleting a recovery point.

Default: false

encryptionKeyOptional
IKeyRef

The server-side encryption key to use to protect your backups.

Default: - an Amazon managed KMS key

lockConfigurationOptional
LockConfiguration

Configuration for AWS Backup Vault Lock.

Default: - AWS Backup Vault Lock is disabled

notificationEventsOptional
BackupVaultEvents[]

The vault events to send.

Default: - all vault events if `notificationTopic` is defined

notificationTopicOptional
ITopic

A SNS topic to send vault events to.

Default: - no notifications

removalPolicyOptional
RemovalPolicy

The removal policy to apply to the vault. Note that removing a vault that contains recovery points will fail.

Default: RemovalPolicy.RETAIN

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter