interface BackupVaultProps

Language	Type name
.NET	`Amazon.CDK.AWS.Backup.BackupVaultProps`
Java	`software.amazon.awscdk.services.backup.BackupVaultProps`
Python	`aws_cdk.aws_backup.BackupVaultProps`
TypeScript (source)	`@aws-cdk/aws-backup` » `BackupVaultProps`

Properties for a BackupVault.

Example

const myKey = kms.Key.fromKeyArn(this, 'MyKey', 'aaa');
const myTopic = sns.Topic.fromTopicArn(this, 'MyTopic', 'bbb');

const vault = new backup.BackupVault(this, 'Vault', {
  encryptionKey: myKey, // Custom encryption key
  notificationTopic: myTopic, // Send all vault events to this SNS topic
});

Properties

Name	Type	Description
accessPolicy?	`PolicyDocument`	A resource-based policy that is used to manage access permissions on the backup vault.
backupVaultName?	`string`	The name of a logical container where backups are stored.
blockRecoveryPointDeletion?	`boolean`	Whether to add statements to the vault access policy that prevents anyone from deleting a recovery point.
encryptionKey?	`IKey`	The server-side encryption key to use to protect your backups.
notificationEvents?	`BackupVaultEvents[]`	The vault events to send.
notificationTopic?	`ITopic`	A SNS topic to send vault events to.
removalPolicy?	`RemovalPolicy`	The removal policy to apply to the vault.

accessPolicy?

Type: PolicyDocument (optional, default: access is not restricted)

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

backupVaultName?

Type: string (optional, default: A CDK generated name)

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.

blockRecoveryPointDeletion?

Type: boolean (optional, default: false)

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

encryptionKey?

Type: IKey (optional, default: an Amazon managed KMS key)

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

notificationEvents?

Type: BackupVaultEvents[] (optional, default: all vault events if notificationTopic is defined)

The vault events to send.

notificationTopic?

Type: ITopic (optional, default: no notifications)

A SNS topic to send vault events to.

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

The removal policy to apply to the vault.

Note that removing a vault that contains recovery points will fail.