Package software.amazon.awscdk.services.fsx

Class CfnVolume.SnaplockConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.CfnVolume.SnaplockConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVolume.SnaplockConfigurationProperty>

Enclosing interface:

CfnVolume.SnaplockConfigurationProperty

@Stability(Stable)
public static final class CfnVolume.SnaplockConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnVolume.SnaplockConfigurationProperty>

A builder for CfnVolume.SnaplockConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnVolume.SnaplockConfigurationProperty.Builder	auditLogVolume(String auditLogVolume)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getAuditLogVolume()
CfnVolume.SnaplockConfigurationProperty.Builder	autocommitPeriod(IResolvable autocommitPeriod)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getAutocommitPeriod()
CfnVolume.SnaplockConfigurationProperty.Builder	autocommitPeriod(CfnVolume.AutocommitPeriodProperty autocommitPeriod)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getAutocommitPeriod()
CfnVolume.SnaplockConfigurationProperty	build()	Builds the configured instance.
CfnVolume.SnaplockConfigurationProperty.Builder	privilegedDelete(String privilegedDelete)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getPrivilegedDelete()
CfnVolume.SnaplockConfigurationProperty.Builder	retentionPeriod(IResolvable retentionPeriod)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getRetentionPeriod()
CfnVolume.SnaplockConfigurationProperty.Builder	retentionPeriod(CfnVolume.SnaplockRetentionPeriodProperty retentionPeriod)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getRetentionPeriod()
CfnVolume.SnaplockConfigurationProperty.Builder	snaplockType(String snaplockType)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getSnaplockType()
CfnVolume.SnaplockConfigurationProperty.Builder	volumeAppendModeEnabled(String volumeAppendModeEnabled)	Sets the value of CfnVolume.SnaplockConfigurationProperty.getVolumeAppendModeEnabled()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

snaplockType

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder snaplockType(String snaplockType)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getSnaplockType()

Parameters:

snaplockType - Specifies the retention mode of an FSx for ONTAP SnapLock volume. This parameter is required. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE : Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance .
• ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise .

Returns:

this

auditLogVolume

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder auditLogVolume(String auditLogVolume)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getAuditLogVolume()

Parameters:

auditLogVolume - Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false . If you set AuditLogVolume to true , the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes .

Returns:

this

autocommitPeriod

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder autocommitPeriod(IResolvable autocommitPeriod)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getAutocommitPeriod()

Parameters:

autocommitPeriod - The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

Returns:

this

autocommitPeriod

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder autocommitPeriod(CfnVolume.AutocommitPeriodProperty autocommitPeriod)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getAutocommitPeriod()

Parameters:

autocommitPeriod - The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

Returns:

this

privilegedDelete

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder privilegedDelete(String privilegedDelete)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getPrivilegedDelete()

Parameters:

privilegedDelete - Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED .

For more information, see Privileged delete .

Returns:

this

retentionPeriod

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder retentionPeriod(IResolvable retentionPeriod)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getRetentionPeriod()

Parameters:

retentionPeriod - Specifies the retention period of an FSx for ONTAP SnapLock volume.

Returns:

this

retentionPeriod

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder retentionPeriod(CfnVolume.SnaplockRetentionPeriodProperty retentionPeriod)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getRetentionPeriod()

Parameters:

retentionPeriod - Specifies the retention period of an FSx for ONTAP SnapLock volume.

Returns:

this

volumeAppendModeEnabled

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty.Builder volumeAppendModeEnabled(String volumeAppendModeEnabled)

Sets the value of CfnVolume.SnaplockConfigurationProperty.getVolumeAppendModeEnabled()

Parameters:

volumeAppendModeEnabled - Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false .

For more information, see Volume-append mode .

Returns:

this

build

@Stability(Stable)
public CfnVolume.SnaplockConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnVolume.SnaplockConfigurationProperty>

Returns:

a new instance of CfnVolume.SnaplockConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided