Package software.amazon.awscdk.services.backup

Interface BackupVaultProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BackupVaultProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.509Z")
@Stability(Stable)
public interface BackupVaultProps
extends software.amazon.jsii.JsiiSerializable

Properties for a BackupVault.

Example:

 IKey myKey = Key.fromKeyArn(this, "MyKey", "aaa");
 ITopic myTopic = Topic.fromTopicArn(this, "MyTopic", "bbb");
 BackupVault vault = BackupVault.Builder.create(this, "Vault")
         .encryptionKey(myKey) // Custom encryption key
         .notificationTopic(myTopic)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BackupVaultProps.Builder	A builder for BackupVaultProps
static final class	BackupVaultProps.Jsii$Proxy	An implementation for BackupVaultProps

Method Summary

Modifier and Type	Method	Description
static BackupVaultProps.Builder	builder()
default PolicyDocument	getAccessPolicy()	A resource-based policy that is used to manage access permissions on the backup vault.
default String	getBackupVaultName()	The name of a logical container where backups are stored.
default Boolean	getBlockRecoveryPointDeletion()	Whether to add statements to the vault access policy that prevents anyone from deleting a recovery point.
default IKey	getEncryptionKey()	The server-side encryption key to use to protect your backups.
default LockConfiguration	getLockConfiguration()	Configuration for AWS Backup Vault Lock.
default List<BackupVaultEvents>	getNotificationEvents()	The vault events to send.
default ITopic	getNotificationTopic()	A SNS topic to send vault events to.
default RemovalPolicy	getRemovalPolicy()	The removal policy to apply to the vault.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessPolicy

@Stability(Stable)
@Nullable
default PolicyDocument getAccessPolicy()

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

Default: - access is not restricted

getBackupVaultName

@Stability(Stable)
@Nullable
default String getBackupVaultName()

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

getBlockRecoveryPointDeletion

@Stability(Stable)
@Nullable
default Boolean getBlockRecoveryPointDeletion()

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

Default: false

getEncryptionKey

@Stability(Stable)
@Nullable
default IKey getEncryptionKey()

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

Default: - an Amazon managed KMS key

getLockConfiguration

@Stability(Stable)
@Nullable
default LockConfiguration getLockConfiguration()

Configuration for AWS Backup Vault Lock.

Default: - AWS Backup Vault Lock is disabled

See Also:

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

getNotificationEvents

@Stability(Stable)
@Nullable
default List<BackupVaultEvents> getNotificationEvents()

The vault events to send.

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

See Also:

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

getNotificationTopic

@Stability(Stable)
@Nullable
default ITopic getNotificationTopic()

A SNS topic to send vault events to.

Default: - no notifications

See Also:

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

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

The removal policy to apply to the vault.

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

Default: RemovalPolicy.RETAIN

builder

@Stability(Stable)
static BackupVaultProps.Builder builder()

Returns:

a BackupVaultProps.Builder of BackupVaultProps