Class: Aws::Backup::Types::PutBackupVaultLockConfigurationInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Note:

When making an API call, you may pass PutBackupVaultLockConfigurationInput data as a hash:

{
  backup_vault_name: "BackupVaultName", # required
  min_retention_days: 1,
  max_retention_days: 1,
  changeable_for_days: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_vault_nameString

The Backup Vault Lock configuration that specifies the name of the backup vault it protects.

Returns:

  • (String)


5036
5037
5038
5039
5040
5041
5042
5043
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5036

class PutBackupVaultLockConfigurationInput < Struct.new(
  :backup_vault_name,
  :min_retention_days,
  :max_retention_days,
  :changeable_for_days)
  SENSITIVE = []
  include Aws::Structure
end

#changeable_for_daysInteger

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.

Returns:

  • (Integer)


5036
5037
5038
5039
5040
5041
5042
5043
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5036

class PutBackupVaultLockConfigurationInput < Struct.new(
  :backup_vault_name,
  :min_retention_days,
  :max_retention_days,
  :changeable_for_days)
  SENSITIVE = []
  include Aws::Structure
end

#max_retention_daysInteger

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. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.

Returns:

  • (Integer)


5036
5037
5038
5039
5040
5041
5042
5043
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5036

class PutBackupVaultLockConfigurationInput < Struct.new(
  :backup_vault_name,
  :min_retention_days,
  :max_retention_days,
  :changeable_for_days)
  SENSITIVE = []
  include Aws::Structure
end

#min_retention_daysInteger

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. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.

Returns:

  • (Integer)


5036
5037
5038
5039
5040
5041
5042
5043
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5036

class PutBackupVaultLockConfigurationInput < Struct.new(
  :backup_vault_name,
  :min_retention_days,
  :max_retention_days,
  :changeable_for_days)
  SENSITIVE = []
  include Aws::Structure
end