Package 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.98.0 (build 00b106d)", date="2024-05-08T21:35:03.256Z") @Stability(Stable) public interface LockConfiguration extends software.amazon.jsii.JsiiSerializable
Configuration for AWS Backup Vault Lock.

Example: 

 BackupVault.Builder.create(this, "Vault")
         .lockConfiguration(LockConfiguration.builder()
                 .minRetention(Duration.days(30))
                 .build())
         .build();

See Also:

  • Method Details

    • getMinRetention

      @Stability(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(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(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(Stable) static LockConfiguration.Builder builder()
      Returns:
      a LockConfiguration.Builder of LockConfiguration