AWS Backup Vault Lock Configuration
This page shows how to write Terraform and CloudFormation for AWS Backup Vault Lock Configuration and write them securely.
aws_backup_vault_lock_configuration (Terraform)
The Vault Lock Configuration in AWS Backup can be configured in Terraform with the resource name aws_backup_vault_lock_configuration
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
The following arguments are supported:
backup_vault_name
- (Required) Name of the backup vault to add a lock configuration for.changeable_for_days
- (Optional) The number of days before the lock date.max_retention_days
- (Optional) The maximum retention period that the vault retains its recovery points.min_retention_days
- (Optional) The minimum retention period that the vault retains its recovery points.
In addition to all arguments above, the following attributes are exported:
backup_vault_name
- The name of the vault.backup_vault_arn
- The ARN of the vault.
Explanation in Terraform Registry
Provides an AWS Backup vault lock configuration resource.
AWS::Backup::BackupVault LockConfigurationType (CloudFormation)
The BackupVault LockConfigurationType in Backup can be configured in CloudFormation with the resource name AWS::Backup::BackupVault LockConfigurationType
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
ChangeableForDays
The AWS Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays
to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.
AWS Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays
to 3 or greater.
Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration
or change the Vault Lock configuration using PutBackupVaultLockConfiguration
. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.
If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration
or change the Vault Lock configuration using PutBackupVaultLockConfiguration
at any time.
Required: No
Type: Double
Update requires: No interruption
MaxRetentionDays
The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).
If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
If this parameter is 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's 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. Recovery points already saved in the vault prior to Vault Lock are not affected.
Required: No
Type: Double
Update requires: No interruption
MinRetentionDays
The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is 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 the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.
Required: Yes
Type: Double
Update requires: No interruption
Explanation in CloudFormation Registry
The
LockConfigurationType
property type specifies configuration for AWS Backup Vault Lock.