aws-cdk-lib.aws_backup.CfnBackupVault.LockConfigurationTypeProperty

LockConfigurationTypeProperty Struct

The LockConfigurationType property type specifies configuration for AWS Backup Vault Lock .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_backup as backup } from 'aws-cdk-lib';
const lockConfigurationTypeProperty: backup.CfnBackupVault.LockConfigurationTypeProperty = {
  minRetentionDays: 123,

  // the properties below are optional
  changeableForDays: 123,
  maxRetentionDays: 123,
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_backup as backup

lock_configuration_type_property = backup.CfnBackupVault.LockConfigurationTypeProperty(
    min_retention_days=123,

    # the properties below are optional
    changeable_for_days=123,
    max_retention_days=123
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.backup.*;

LockConfigurationTypeProperty lockConfigurationTypeProperty = LockConfigurationTypeProperty.builder()
        .minRetentionDays(123)

        // the properties below are optional
        .changeableForDays(123)
        .maxRetentionDays(123)
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Backup;

var lockConfigurationTypeProperty = new LockConfigurationTypeProperty {
    MinRetentionDays = 123,

    // the properties below are optional
    ChangeableForDays = 123,
    MaxRetentionDays = 123
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

lockConfigurationTypeProperty := &LockConfigurationTypeProperty{
	MinRetentionDays: jsii.Number(123),

	// the properties below are optional
	ChangeableForDays: jsii.Number(123),
	MaxRetentionDays: jsii.Number(123),
}

Properties

changeableForDays?optionalnumberchangeable_for_days?optionalint | floatchangeableForDays?optionalNumberChangeableForDays?optionaldoubleChangeableForDays?optional*float64#

The AWS Backup Vault Lock configuration that specifies the number of days before the lock date.

notes

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.

maxRetentionDays?optionalnumbermax_retention_days?optionalint | floatmaxRetentionDays?optionalNumberMaxRetentionDays?optionaldoubleMaxRetentionDays?optional*float64#

The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points.

notes

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.

minRetentionDaysnumbermin_retention_daysint | floatminRetentionDaysNumberMinRetentionDaysdoubleMinRetentionDays*float64required#

The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points.

notes

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.