CreateLogicallyAirGappedBackupVault - Amazon Backup
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).

CreateLogicallyAirGappedBackupVault

This request 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", "MaxRetentionDays": number, "MinRetentionDays": number }

URI Request Parameters

The request uses the following URI parameters.

backupVaultName

This is the name of the vault that is being created.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

BackupVaultTags

These are the tags that will be included in the newly-created vault.

Type: String to string map

Required: No

CreatorRequestId

This is 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

MaxRetentionDays

This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Amazon Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

Type: Long

Required: Yes

MinRetentionDays

This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

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

This is the ARN (Amazon Resource Name) of the vault being created.

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. They consist of lowercase letters, numbers, and hyphens.

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

This is 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 Errors.

AlreadyExistsException

The required resource already exists.

HTTP Status Code: 400

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

HTTP Status Code: 400

LimitExceededException

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: