Package software.amazon.awscdk.services.backup

Interface CfnLogicallyAirGappedBackupVaultProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogicallyAirGappedBackupVaultProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:05.592Z")
@Stability(Stable)
public interface CfnLogicallyAirGappedBackupVaultProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLogicallyAirGappedBackupVault.

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;
 CfnLogicallyAirGappedBackupVaultProps cfnLogicallyAirGappedBackupVaultProps = CfnLogicallyAirGappedBackupVaultProps.builder()
         .backupVaultName("backupVaultName")
         .maxRetentionDays(123)
         .minRetentionDays(123)
         // the properties below are optional
         .accessPolicy(accessPolicy)
         .backupVaultTags(Map.of(
                 "backupVaultTagsKey", "backupVaultTags"))
         .encryptionKeyArn("encryptionKeyArn")
         .mpaApprovalTeamArn("mpaApprovalTeamArn")
         .notifications(NotificationObjectTypeProperty.builder()
                 .backupVaultEvents(List.of("backupVaultEvents"))
                 .snsTopicArn("snsTopicArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLogicallyAirGappedBackupVaultProps.Builder	builder()
default Object	getAccessPolicy()	The backup vault access policy document in JSON format.
String	getBackupVaultName()	The name of a logical container where backups are stored.
default Map<String,String>	getBackupVaultTags()	The tags to assign to the vault.
default String	getEncryptionKeyArn()	The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
Number	getMaxRetentionDays()	The maximum retention period that the vault retains its recovery points.
Number	getMinRetentionDays()	This setting specifies the minimum retention period that the vault retains its recovery points.
default String	getMpaApprovalTeamArn()	The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.
default Object	getNotifications()	Returns event notifications for the specified backup vault.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBackupVaultName

@Stability(Stable)
@NotNull
String getBackupVaultName()

The name of a logical container where backups are stored.

Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaultname

getMaxRetentionDays

@Stability(Stable)
@NotNull
Number getMaxRetentionDays()

The maximum retention period that the vault retains its recovery points.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-maxretentiondays

getMinRetentionDays

@Stability(Stable)
@NotNull
Number getMinRetentionDays()

This setting specifies the minimum retention period that the vault retains its recovery points.

The minimum value accepted is 7 days.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-minretentiondays

getAccessPolicy

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

The backup vault access policy document in JSON format.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-accesspolicy

getBackupVaultTags

@Stability(Stable)
@Nullable
default Map<String,String> getBackupVaultTags()

The tags to assign to the vault.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaulttags

getEncryptionKeyArn

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

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

If this field is left blank, AWS Backup will create an AWS owned key to be used to encrypt the content of the logically air-gapped vault. The ARN of this created key will be available as Fn::GetAtt output.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-encryptionkeyarn

getMpaApprovalTeamArn

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

The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.

This cannot be changed after it is set from the CloudFormation template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-mpaapprovalteamarn

getNotifications

@Stability(Stable)
@Nullable
default Object getNotifications()

Returns event notifications for the specified backup vault.

Returns union: either IResolvable or CfnLogicallyAirGappedBackupVault.NotificationObjectTypeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-notifications

builder

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

Returns:

a CfnLogicallyAirGappedBackupVaultProps.Builder of CfnLogicallyAirGappedBackupVaultProps