Interface BackupVaultProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BackupVaultProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.606Z") @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();
 
  • 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

    • getNotificationEvents

      @Stability(Stable) @Nullable default List<BackupVaultEvents> getNotificationEvents()
      The vault events to send.

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

      See Also:
    • getNotificationTopic

      @Stability(Stable) @Nullable default ITopic getNotificationTopic()
      A SNS topic to send vault events to.

      Default: - no notifications

      See Also:
    • 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