Backup / Client / create_logically_air_gapped_backup_vault

create_logically_air_gapped_backup_vault#

Backup.Client.create_logically_air_gapped_backup_vault(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_logically_air_gapped_backup_vault(
    BackupVaultName='string',
    BackupVaultTags={
        'string': 'string'
    },
    CreatorRequestId='string',
    MinRetentionDays=123,
    MaxRetentionDays=123
)
Parameters:

  • BackupVaultName (string) –

    [REQUIRED]

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

  • BackupVaultTags (dict) –

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

    • (string) –

      • (string) –

  • CreatorRequestId (string) –

    This is the ID of the creation request.

    This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

  • MinRetentionDays (integer) –

    [REQUIRED]

    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.

  • MaxRetentionDays (integer) –

    [REQUIRED]

    This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, 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.

Return type:

dict

Returns:

Response Syntax

{
    'BackupVaultName': 'string',
    'BackupVaultArn': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'VaultState': 'CREATING'|'AVAILABLE'|'FAILED'
}

Response Structure

  • (dict) –

    • BackupVaultName (string) –

      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.

    • BackupVaultArn (string) –

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

    • CreationDate (datetime) –

      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.

    • VaultState (string) –

      This is the current state of the vault.

Exceptions

  • Backup.Client.exceptions.AlreadyExistsException

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.LimitExceededException

  • Backup.Client.exceptions.MissingParameterValueException

  • Backup.Client.exceptions.ServiceUnavailableException

  • Backup.Client.exceptions.InvalidRequestException