interface CfnBackupVaultProps

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

Properties for defining a CfnBackupVault.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_backup as backup } from 'aws-cdk-lib';

declare const accessPolicy: any;
const cfnBackupVaultProps: backup.CfnBackupVaultProps = {
  backupVaultName: 'backupVaultName',

  // the properties below are optional
  accessPolicy: accessPolicy,
  backupVaultTags: {
    backupVaultTagsKey: 'backupVaultTags',
  },
  encryptionKeyArn: 'encryptionKeyArn',
  lockConfiguration: {
    minRetentionDays: 123,

    // the properties below are optional
    changeableForDays: 123,
    maxRetentionDays: 123,
  },
  notifications: {
    backupVaultEvents: ['backupVaultEvents'],
    snsTopicArn: 'snsTopicArn',
  },
};

Properties

Name	Type	Description
backupVaultName	`string`	The name of a logical container where backups are stored.
accessPolicy?	`any`	A resource-based policy that is used to manage access permissions on the target backup vault.
backupVaultTags?	`{ [string]: string }`	The tags to assign to the backup vault.
encryptionKeyArn?	`string`	A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;
lockConfiguration?	`IResolvable` `\|` `LockConfigurationTypeProperty`	Configuration for AWS Backup Vault Lock .
notifications?	`IResolvable` `\|` `NotificationObjectTypeProperty`	The SNS event notifications for the specified backup vault.

backupVaultName

Type: 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.

accessPolicy?

Type: any (optional)

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

backupVaultTags?

Type: { [string]: string } (optional)

The tags to assign to the backup vault.

encryptionKeyArn?

Type: string (optional)

A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;

for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default.

To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see Encryption for backups in AWS Backup

lockConfiguration?

Type: IResolvable | LockConfigurationTypeProperty (optional)

Configuration for AWS Backup Vault Lock .

notifications?

Type: IResolvable | NotificationObjectTypeProperty (optional)

The SNS event notifications for the specified backup vault.