Package software.amazon.awscdk.services.backup

Class CfnBackupVault

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.backup.CfnBackupVault
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IBackupVaultRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:35.065Z") @Stability(Stable) public class CfnBackupVault extends CfnResource implements IInspectable, IBackupVaultRef, ITaggableV2
Creates a logical container where backups are stored.

A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

For a sample AWS CloudFormation template, see the AWS Backup Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 Object accessPolicy;
 CfnBackupVault cfnBackupVault = CfnBackupVault.Builder.create(this, "MyCfnBackupVault")
         .backupVaultName("backupVaultName")
         // the properties below are optional
         .accessPolicy(accessPolicy)
         .backupVaultTags(Map.of(
                 "backupVaultTagsKey", "backupVaultTags"))
         .encryptionKeyArn("encryptionKeyArn")
         .lockConfiguration(LockConfigurationTypeProperty.builder()
                 .minRetentionDays(123)
                 // the properties below are optional
                 .changeableForDays(123)
                 .maxRetentionDays(123)
                 .build())
         .notifications(NotificationObjectTypeProperty.builder()
                 .backupVaultEvents(List.of("backupVaultEvents"))
                 .snsTopicArn("snsTopicArn")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBackupVault

      protected CfnBackupVault(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBackupVault

      protected CfnBackupVault(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBackupVault

      @Stability(Stable) public CfnBackupVault(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnBackupVaultProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromBackupVaultArn

      @Stability(Stable) @NotNull public static IBackupVaultRef fromBackupVaultArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IBackupVaultRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromBackupVaultName

      @Stability(Stable) @NotNull public static IBackupVaultRef fromBackupVaultName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String backupVaultName)
      Creates a new IBackupVaultRef from a backupVaultName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      backupVaultName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrBackupVaultArn

      @Stability(Stable) @NotNull public String getAttrBackupVaultArn()
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault;

      for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault .

    • getAttrBackupVaultName

      @Stability(Stable) @NotNull public String getAttrBackupVaultName()
      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 Region where they are created. They consist of lowercase and uppercase letters, numbers, and hyphens.

    • getBackupVaultRef

      @Stability(Stable) @NotNull public BackupVaultReference getBackupVaultRef()
      A reference to a BackupVault resource.
      Specified by:
      getBackupVaultRef in interface IBackupVaultRef

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getBackupVaultName

      @Stability(Stable) @NotNull public String getBackupVaultName()
      The name of a logical container where backups are stored.

    • setBackupVaultName

      @Stability(Stable) public void setBackupVaultName(@NotNull String value)
      The name of a logical container where backups are stored.

    • getAccessPolicy

      @Stability(Stable) @Nullable public Object getAccessPolicy()
      A resource-based policy that is used to manage access permissions on the target backup vault.

    • setAccessPolicy

      @Stability(Stable) public void setAccessPolicy(@Nullable Object value)
      A resource-based policy that is used to manage access permissions on the target backup vault.

    • getBackupVaultTags

      @Stability(Stable) @Nullable public Map<String,String> getBackupVaultTags()
      The tags to assign to the backup vault.

    • setBackupVaultTags

      @Stability(Stable) public void setBackupVaultTags(@Nullable Map<String,String> value)
      The tags to assign to the backup vault.

    • getEncryptionKeyArn

      @Stability(Stable) @Nullable public String getEncryptionKeyArn()
      A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;

    • setEncryptionKeyArn

      @Stability(Stable) public void setEncryptionKeyArn(@Nullable String value)
      A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;

    • getLockConfiguration

      @Stability(Stable) @Nullable public Object getLockConfiguration()
      Configuration for AWS Backup Vault Lock .

      Returns union: either IResolvable or CfnBackupVault.LockConfigurationTypeProperty

    • setLockConfiguration

      @Stability(Stable) public void setLockConfiguration(@Nullable IResolvable value)
      Configuration for AWS Backup Vault Lock .

    • setLockConfiguration

      @Stability(Stable) public void setLockConfiguration(@Nullable CfnBackupVault.LockConfigurationTypeProperty value)
      Configuration for AWS Backup Vault Lock .

    • getNotifications

      @Stability(Stable) @Nullable public Object getNotifications()
      The SNS event notifications for the specified backup vault.

      Returns union: either IResolvable or CfnBackupVault.NotificationObjectTypeProperty

    • setNotifications

      @Stability(Stable) public void setNotifications(@Nullable IResolvable value)
      The SNS event notifications for the specified backup vault.

    • setNotifications

      @Stability(Stable) public void setNotifications(@Nullable CfnBackupVault.NotificationObjectTypeProperty value)
      The SNS event notifications for the specified backup vault.