software.amazon.awscdk.services.backup

Interface LockConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LockConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.867Z")
 @Stability(value=Stable)
public interface LockConfiguration
extends software.amazon.jsii.JsiiSerializable

Configuration for AWS Backup Vault Lock.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.backup.*;
 LockConfiguration lockConfiguration = LockConfiguration.builder()
         .minRetention(Duration.minutes(30))
         // the properties below are optional
         .changeableFor(Duration.minutes(30))
         .maxRetention(Duration.minutes(30))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LockConfiguration.Builder A builder for LockConfiguration
static class	LockConfiguration.Jsii$Proxy An implementation for LockConfiguration

Method Summary

Modifier and Type	Method and Description
static LockConfiguration.Builder	builder()
default Duration	getChangeableFor() The duration before the lock date.
default Duration	getMaxRetention() The maximum retention period that the vault retains its recovery points.
Duration	getMinRetention() The minimum retention period that the vault retains its recovery points.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMinRetention

@Stability(value=Stable)
 @NotNull
Duration getMinRetention()

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

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.

getChangeableFor

@Stability(value=Stable)
 @Nullable
default Duration getChangeableFor()

The duration before the lock date.

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

getMaxRetention

@Stability(value=Stable)
 @Nullable
default Duration getMaxRetention()

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

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

builder

@Stability(value=Stable)
static LockConfiguration.Builder builder()

Returns:

a LockConfiguration.Builder of LockConfiguration