Interface IBackupVaultProps

Properties for a BackupVault.

Namespace: Amazon.CDK.AWS.Backup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IBackupVaultProps

Syntax (vb)

Public Interface IBackupVaultProps

Remarks

ExampleMetadata: infused

Examples

var myKey = Key.FromKeyArn(this, "MyKey", "aaa");
var myTopic = Topic.FromTopicArn(this, "MyTopic", "bbb");

var vault = new BackupVault(this, "Vault", new BackupVaultProps {
    EncryptionKey = myKey,  // Custom encryption key
    NotificationTopic = myTopic
});

Synopsis

Properties

AccessPolicy	A resource-based policy that is used to manage access permissions on the backup vault.
BackupVaultName	The name of a logical container where backups are stored.
BlockRecoveryPointDeletion	Whether to add statements to the vault access policy that prevents anyone from deleting a recovery point.
EncryptionKey	The server-side encryption key to use to protect your backups.
LockConfiguration	Configuration for AWS Backup Vault Lock.
NotificationEvents	The vault events to send.
NotificationTopic	A SNS topic to send vault events to.
RemovalPolicy	The removal policy to apply to the vault.

Properties

AccessPolicy

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

virtual PolicyDocument AccessPolicy { get; }

Property Value

PolicyDocument

Remarks

Default: - access is not restricted

BackupVaultName

The name of a logical container where backups are stored.

virtual string BackupVaultName { get; }

Property Value

System.String

Remarks

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

BlockRecoveryPointDeletion

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

virtual Nullable<bool> BlockRecoveryPointDeletion { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

EncryptionKey

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

virtual IKey EncryptionKey { get; }

Property Value

IKey

Remarks

Default: - an Amazon managed KMS key

LockConfiguration

Configuration for AWS Backup Vault Lock.

virtual ILockConfiguration LockConfiguration { get; }

Property Value

ILockConfiguration

Remarks

Default: - AWS Backup Vault Lock is disabled

See: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html

NotificationEvents

The vault events to send.

virtual BackupVaultEvents[] NotificationEvents { get; }

Property Value

BackupVaultEvents[]

Remarks

Default: - all vault events if notificationTopic is defined

See: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html

NotificationTopic

A SNS topic to send vault events to.

virtual ITopic NotificationTopic { get; }

Property Value

ITopic

Remarks

Default: - no notifications

See: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html

RemovalPolicy

The removal policy to apply to the vault.

virtual Nullable<RemovalPolicy> RemovalPolicy { get; }

Property Value

System.Nullable<RemovalPolicy>

Remarks

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

Default: RemovalPolicy.RETAIN