AWS aws-backup documentation change
Summary
Added documentation for encryption status (IsEncrypted), KMS key usage (EncryptionKeyArn), recovery point lifecycle management, and vault lock state/type fields
Security assessment
Adds documentation about encryption implementation details, compliance locking mechanisms (VaultLockState), and air-gapped vault security controls (VaultType) which are security features but does not indicate any vulnerability being addressed
Diff
diff --git a/aws-backup/latest/devguide/API_BackupJob.md b/aws-backup/latest/devguide/API_BackupJob.md index e9cdccef6..ed25e2339 100644 --- a//aws-backup/latest/devguide/API_BackupJob.md +++ b//aws-backup/latest/devguide/API_BackupJob.md @@ -142,0 +143,9 @@ Required: No +**EncryptionKeyArn** + + +The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an AWS managed key, depending on the vault configuration. + +Type: String + +Required: No + @@ -169,0 +179,9 @@ Required: No +**IsEncrypted** + + +A boolean value indicating whether the backup is encrypted. All backups in AWS Backup are encrypted, but this field indicates the encryption status for transparency. + +Type: Boolean + +Required: No + @@ -220,0 +239,15 @@ Required: No +**RecoveryPointLifecycle** + + +Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. + +Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold. + +Resource types that can transition to cold storage are listed in the [Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types. + +To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for `MoveToColdStorageAfterDays` and `DeleteAfterDays`. + +Type: [Lifecycle](./API_Lifecycle.html) object + +Required: No + @@ -278,0 +312,18 @@ Required: No +**VaultLockState** + + +The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include `LOCKED` and `UNLOCKED`. + +Type: String + +Required: No + +**VaultType** + + +The type of backup vault where the recovery point is stored. Valid values are `BACKUP_VAULT` for standard backup vaults and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` for logically air-gapped vaults. + +Type: String + +Required: No +