Package software.amazon.awscdk.services.backup

Class CfnLogicallyAirGappedBackupVault

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.CfnLogicallyAirGappedBackupVault
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, ILogicallyAirGappedBackupVaultRef, 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.072Z") @Stability(Stable) public class CfnLogicallyAirGappedBackupVault extends CfnResource implements IInspectable, ILogicallyAirGappedBackupVaultRef, ITaggableV2
Creates a logical container to where backups may be copied.

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

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

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;
 CfnLogicallyAirGappedBackupVault cfnLogicallyAirGappedBackupVault = CfnLogicallyAirGappedBackupVault.Builder.create(this, "MyCfnLogicallyAirGappedBackupVault")
         .backupVaultName("backupVaultName")
         .maxRetentionDays(123)
         .minRetentionDays(123)
         // the properties below are optional
         .accessPolicy(accessPolicy)
         .backupVaultTags(Map.of(
                 "backupVaultTagsKey", "backupVaultTags"))
         .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

    • CfnLogicallyAirGappedBackupVault

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

    • CfnLogicallyAirGappedBackupVault

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

    • CfnLogicallyAirGappedBackupVault

      @Stability(Stable) public CfnLogicallyAirGappedBackupVault(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLogicallyAirGappedBackupVaultProps 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

    • fromBackupVaultName

      @Stability(Stable) @NotNull public static ILogicallyAirGappedBackupVaultRef fromBackupVaultName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String backupVaultName)
      Creates a new ILogicallyAirGappedBackupVaultRef 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()
      The ARN of the backup vault.

    • getAttrEncryptionKeyArn

      @Stability(Stable) @NotNull public String getAttrEncryptionKeyArn()
      The ARN of the server-side encryption key.

    • getAttrVaultState

      @Stability(Stable) @NotNull public String getAttrVaultState()
      The vault state.

      The possible values are CREATING , AVAILABLE , and FAILED .

    • getAttrVaultType

      @Stability(Stable) @NotNull public String getAttrVaultType()
      The vault type.

      The possible values are BACKUP_VAULT and LOGICALLY_AIR_GAPPED_BACKUP_VAULT .

    • 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

    • getLogicallyAirGappedBackupVaultRef

      @Stability(Stable) @NotNull public LogicallyAirGappedBackupVaultReference getLogicallyAirGappedBackupVaultRef()
      A reference to a LogicallyAirGappedBackupVault resource.
      Specified by:
      getLogicallyAirGappedBackupVaultRef in interface ILogicallyAirGappedBackupVaultRef

    • 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.

    • getMaxRetentionDays

      @Stability(Stable) @NotNull public Number getMaxRetentionDays()
      The maximum retention period that the vault retains its recovery points.

    • setMaxRetentionDays

      @Stability(Stable) public void setMaxRetentionDays(@NotNull Number value)
      The maximum retention period that the vault retains its recovery points.

    • getMinRetentionDays

      @Stability(Stable) @NotNull public Number getMinRetentionDays()
      This setting specifies the minimum retention period that the vault retains its recovery points.

    • setMinRetentionDays

      @Stability(Stable) public void setMinRetentionDays(@NotNull Number value)
      This setting specifies the minimum retention period that the vault retains its recovery points.

    • getAccessPolicy

      @Stability(Stable) @Nullable public Object getAccessPolicy()
      The backup vault access policy document in JSON format.

    • setAccessPolicy

      @Stability(Stable) public void setAccessPolicy(@Nullable Object value)
      The backup vault access policy document in JSON format.

    • getBackupVaultTags

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

    • setBackupVaultTags

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

    • getNotifications

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

      Returns union: either IResolvable or CfnLogicallyAirGappedBackupVault.NotificationObjectTypeProperty

    • setNotifications

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

    • setNotifications

      @Stability(Stable) public void setNotifications(@Nullable CfnLogicallyAirGappedBackupVault.NotificationObjectTypeProperty value)
      Returns event notifications for the specified backup vault.