software.amazon.awscdk.services.backup

Class LockConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.backup.LockConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LockConfiguration>

Enclosing interface:

LockConfiguration

@Stability(value=Stable)
public static final class LockConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<LockConfiguration>

A builder for LockConfiguration

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LockConfiguration	build() Builds the configured instance.
LockConfiguration.Builder	changeableFor(Duration changeableFor) Sets the value of LockConfiguration.getChangeableFor()
LockConfiguration.Builder	maxRetention(Duration maxRetention) Sets the value of LockConfiguration.getMaxRetention()
LockConfiguration.Builder	minRetention(Duration minRetention) Sets the value of LockConfiguration.getMinRetention()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

minRetention

@Stability(value=Stable)
public LockConfiguration.Builder minRetention(Duration minRetention)

Sets the value of LockConfiguration.getMinRetention()

Parameters:

minRetention - The minimum retention period that the vault retains its recovery points. This parameter is required. 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.

Returns:

this

changeableFor

@Stability(value=Stable)
public LockConfiguration.Builder changeableFor(Duration changeableFor)

Sets the value of LockConfiguration.getChangeableFor()

Parameters:

changeableFor - 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.

Returns:

this

maxRetention

@Stability(value=Stable)
public LockConfiguration.Builder maxRetention(Duration maxRetention)

Sets the value of LockConfiguration.getMaxRetention()

Parameters:

maxRetention - 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.

Returns:

this

build

@Stability(value=Stable)
public LockConfiguration build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<LockConfiguration>

Returns:

a new instance of LockConfiguration

Throws:

NullPointerException - if any required attribute was not provided