Skip to content

Creates a logical container to where backups may be copied

Description

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.

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

Usage

backup_create_logically_air_gapped_backup_vault(BackupVaultName,
  BackupVaultTags, CreatorRequestId, MinRetentionDays, MaxRetentionDays,
  EncryptionKeyArn)

Arguments

  • BackupVaultName

    [required] 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.

  • BackupVaultTags

    The tags to assign to the vault.

  • CreatorRequestId

    The ID of the creation request.

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

  • MinRetentionDays

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

    The minimum value accepted is 7 days.

  • MaxRetentionDays

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

  • 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 Amazon Web Services-owned key managed by Amazon Web Services Backup.

Value

A list with the following syntax:

list(
  BackupVaultName = "string",
  BackupVaultArn = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  VaultState = "CREATING"|"AVAILABLE"|"FAILED"
)

Request syntax

svc$create_logically_air_gapped_backup_vault(
  BackupVaultName = "string",
  BackupVaultTags = list(
    "string"
  ),
  CreatorRequestId = "string",
  MinRetentionDays = 123,
  MaxRetentionDays = 123,
  EncryptionKeyArn = "string"
)