AWS::Backup::LogicallyAirGappedBackupVault - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Backup::LogicallyAirGappedBackupVault

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.

Note

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Backup::LogicallyAirGappedBackupVault",
  "Properties" : {
      "AccessPolicy" : Json,
      "BackupVaultName" : String,
      "BackupVaultTags" : {Key: Value, ...},
      "MaxRetentionDays" : Integer,
      "MinRetentionDays" : Integer,
      "Notifications" : NotificationObjectType
    }
}

YAML

Type: AWS::Backup::LogicallyAirGappedBackupVault
Properties:
  AccessPolicy: Json
  BackupVaultName: String
  BackupVaultTags: 
    Key: Value
  MaxRetentionDays: Integer
  MinRetentionDays: Integer
  Notifications: 
    NotificationObjectType

Properties

AccessPolicy

The backup vault access policy document in JSON format.

Required: No

Type: Json

Update requires: No interruption

BackupVaultName

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.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

Update requires: Replacement

BackupVaultTags

The tags to assign to the vault.

Required: No

Type: Object of String

Pattern: ^.{1,128}$

Update requires: No interruption

MaxRetentionDays

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

Required: Yes

Type: Integer

Update requires: Replacement

MinRetentionDays

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

The minimum value accepted is 7 days.

Required: Yes

Type: Integer

Update requires: Replacement

Notifications

Returns event notifications for the specified backup vault.

Required: No

Type: NotificationObjectType

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the backup vault.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

BackupVaultArn

The ARN of the backup vault.

EncryptionKeyArn

The ARN of the server-side encryption key.

VaultState

The vault state. The possible values are CREATING, AVAILABLE, and FAILED.

VaultType

The vault type. The possible values are BACKUP_VAULT and LOGICALLY_AIR_GAPPED_BACKUP_VAULT.