Class LockConfiguration

Configuration for AWS Backup Vault Lock.

Inheritance
object
LockConfiguration
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class LockConfiguration : ILockConfiguration
Syntax (vb)
Public Class LockConfiguration Implements ILockConfiguration
Remarks

See: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html

ExampleMetadata: infused

Examples
new BackupVault(this, "Vault", new BackupVaultProps {
                 LockConfiguration = new LockConfiguration {
                     MinRetention = Duration.Days(30)
                 }
             });

Synopsis

Constructors

LockConfiguration()

Configuration for AWS Backup Vault Lock.

Properties

ChangeableFor

The duration before the lock date.
MaxRetention

The maximum retention period that the vault retains its recovery points.
MinRetention

The minimum retention period that the vault retains its recovery points.

Constructors

LockConfiguration()

Configuration for AWS Backup Vault Lock.

public LockConfiguration()
Remarks

See: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html

ExampleMetadata: infused

Examples
new BackupVault(this, "Vault", new BackupVaultProps {
                 LockConfiguration = new LockConfiguration {
                     MinRetention = Duration.Days(30)
                 }
             });

Properties

ChangeableFor

The duration before the lock date.

public Duration? ChangeableFor { get; set; }
Property Value

Duration

Remarks

AWS Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable.

Before the lock date, you can delete Vault Lock from the vault or change the Vault Lock configuration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.

Default: - Vault Lock can be deleted or changed at any time

MaxRetention

The maximum retention period that the vault retains its recovery points.

public Duration? MaxRetention { get; set; }
Property Value

Duration

Remarks

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.

Default: - Vault Lock does not enforce a maximum retention period

MinRetention

The minimum retention period that the vault retains its recovery points.

public Duration MinRetention { get; set; }
Property Value

Duration

Remarks

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.

Implements