CreateLogicallyAirGappedBackupVault
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.
Request Syntax
PUT /logically-air-gapped-backup-vaults/backupVaultName HTTP/1.1
Content-type: application/json
{
"BackupVaultTags": {
"string" : "string"
},
"CreatorRequestId": "string",
"EncryptionKeyArn": "string",
"MaxRetentionDays": number,
"MinRetentionDays": number
}URI Request Parameters
The request uses the following URI parameters.
- 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.
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- BackupVaultTags
-
The tags to assign to the vault.
Type: String to string map
Required: No
- CreatorRequestId
-
The ID of the creation request.
This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
Type: String
Required: No
- EncryptionKeyArn
-
The ARN of the customer-managed KMS key to use for encrypting the logically air-gapped backup vault. If not specified, the vault will be encrypted with an AWS-owned key managed by AWS Backup.
Type: String
Required: No
- MaxRetentionDays
-
The maximum retention period that the vault retains its recovery points.
Type: Long
Required: Yes
- MinRetentionDays
-
This setting specifies the minimum retention period that the vault retains its recovery points.
The minimum value accepted is 7 days.
Type: Long
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number,
"VaultState": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BackupVaultArn
-
The ARN (Amazon Resource Name) of the vault.
Type: String
- 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.
Type: String
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$ - CreationDate
-
The date and time when the vault was created.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
- VaultState
-
The current state of the vault.
Type: String
Valid Values:
CREATING | AVAILABLE | FAILED
Errors
For information about the errors that are common to all actions, see Common Error Types.