Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Synopsis
- data PutBackupVaultLockConfiguration = PutBackupVaultLockConfiguration' {}
- newPutBackupVaultLockConfiguration :: Text -> PutBackupVaultLockConfiguration
- putBackupVaultLockConfiguration_maxRetentionDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer)
- putBackupVaultLockConfiguration_changeableForDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer)
- putBackupVaultLockConfiguration_minRetentionDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer)
- putBackupVaultLockConfiguration_backupVaultName :: Lens' PutBackupVaultLockConfiguration Text
- data PutBackupVaultLockConfigurationResponse = PutBackupVaultLockConfigurationResponse' {
- newPutBackupVaultLockConfigurationResponse :: PutBackupVaultLockConfigurationResponse
Creating a Request
data PutBackupVaultLockConfiguration Source #
See: newPutBackupVaultLockConfiguration
smart constructor.
PutBackupVaultLockConfiguration' | |
|
Instances
newPutBackupVaultLockConfiguration Source #
Create a value of PutBackupVaultLockConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxRetentionDays:PutBackupVaultLockConfiguration'
, putBackupVaultLockConfiguration_maxRetentionDays
- The 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.
$sel:changeableForDays:PutBackupVaultLockConfiguration'
, putBackupVaultLockConfiguration_changeableForDays
- The 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.
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.
$sel:minRetentionDays:PutBackupVaultLockConfiguration'
, putBackupVaultLockConfiguration_minRetentionDays
- The 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.
$sel:backupVaultName:PutBackupVaultLockConfiguration'
, putBackupVaultLockConfiguration_backupVaultName
- The Backup Vault Lock configuration that specifies the name of the
backup vault it protects.
Request Lenses
putBackupVaultLockConfiguration_maxRetentionDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer) Source #
The 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.
putBackupVaultLockConfiguration_changeableForDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer) Source #
The 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.
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.
putBackupVaultLockConfiguration_minRetentionDays :: Lens' PutBackupVaultLockConfiguration (Maybe Integer) Source #
The 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.
putBackupVaultLockConfiguration_backupVaultName :: Lens' PutBackupVaultLockConfiguration Text Source #
The Backup Vault Lock configuration that specifies the name of the backup vault it protects.
Destructuring the Response
data PutBackupVaultLockConfigurationResponse Source #
See: newPutBackupVaultLockConfigurationResponse
smart constructor.
Instances
Eq PutBackupVaultLockConfigurationResponse Source # | |
Read PutBackupVaultLockConfigurationResponse Source # | |
Show PutBackupVaultLockConfigurationResponse Source # | |
Generic PutBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.PutBackupVaultLockConfiguration type Rep PutBackupVaultLockConfigurationResponse :: Type -> Type # | |
NFData PutBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.PutBackupVaultLockConfiguration rnf :: PutBackupVaultLockConfigurationResponse -> () # | |
type Rep PutBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.PutBackupVaultLockConfiguration type Rep PutBackupVaultLockConfigurationResponse = D1 ('MetaData "PutBackupVaultLockConfigurationResponse" "Amazonka.Backup.PutBackupVaultLockConfiguration" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "PutBackupVaultLockConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newPutBackupVaultLockConfigurationResponse :: PutBackupVaultLockConfigurationResponse Source #
Create a value of PutBackupVaultLockConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.