software.amazon.awssdk.services.fsx.model

Interface UpdateSnaplockConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UpdateSnaplockConfiguration.Builder,UpdateSnaplockConfiguration>, SdkBuilder<UpdateSnaplockConfiguration.Builder,UpdateSnaplockConfiguration>, SdkPojo

Enclosing class:

UpdateSnaplockConfiguration

public static interface UpdateSnaplockConfiguration.Builder
extends SdkPojo, CopyableBuilder<UpdateSnaplockConfiguration.Builder,UpdateSnaplockConfiguration>

Method Summary

Modifier and Type	Method and Description
UpdateSnaplockConfiguration.Builder	auditLogVolume(Boolean auditLogVolume) Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
UpdateSnaplockConfiguration.Builder	autocommitPeriod(AutocommitPeriod autocommitPeriod) The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
default UpdateSnaplockConfiguration.Builder	autocommitPeriod(Consumer<AutocommitPeriod.Builder> autocommitPeriod) The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
UpdateSnaplockConfiguration.Builder	privilegedDelete(PrivilegedDelete privilegedDelete) Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
UpdateSnaplockConfiguration.Builder	privilegedDelete(String privilegedDelete) Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
default UpdateSnaplockConfiguration.Builder	retentionPeriod(Consumer<SnaplockRetentionPeriod.Builder> retentionPeriod) Specifies the retention period of an FSx for ONTAP SnapLock volume.
UpdateSnaplockConfiguration.Builder	retentionPeriod(SnaplockRetentionPeriod retentionPeriod) Specifies the retention period of an FSx for ONTAP SnapLock volume.
UpdateSnaplockConfiguration.Builder	volumeAppendModeEnabled(Boolean volumeAppendModeEnabled) Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

auditLogVolume

UpdateSnaplockConfiguration.Builder auditLogVolume(Boolean 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.

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:

Returns a reference to this object so that method calls can be chained together.

autocommitPeriod

UpdateSnaplockConfiguration.Builder autocommitPeriod(AutocommitPeriod autocommitPeriod)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

autocommitPeriod

default UpdateSnaplockConfiguration.Builder autocommitPeriod(Consumer<AutocommitPeriod.Builder> autocommitPeriod)

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

This is a convenience method that creates an instance of the AutocommitPeriod.Builder avoiding the need to create one manually via AutocommitPeriod.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autocommitPeriod(AutocommitPeriod).

Parameters:

autocommitPeriod - a consumer that will call methods on AutocommitPeriod.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

autocommitPeriod(AutocommitPeriod)

privilegedDelete

UpdateSnaplockConfiguration.Builder privilegedDelete(String 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.

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

PrivilegedDelete, PrivilegedDelete

privilegedDelete

UpdateSnaplockConfiguration.Builder privilegedDelete(PrivilegedDelete 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.

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

PrivilegedDelete, PrivilegedDelete

retentionPeriod

UpdateSnaplockConfiguration.Builder retentionPeriod(SnaplockRetentionPeriod retentionPeriod)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

retentionPeriod

default UpdateSnaplockConfiguration.Builder retentionPeriod(Consumer<SnaplockRetentionPeriod.Builder> retentionPeriod)

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

This is a convenience method that creates an instance of the SnaplockRetentionPeriod.Builder avoiding the need to create one manually via SnaplockRetentionPeriod.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retentionPeriod(SnaplockRetentionPeriod).

Parameters:

retentionPeriod - a consumer that will call methods on SnaplockRetentionPeriod.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

retentionPeriod(SnaplockRetentionPeriod)

volumeAppendModeEnabled

UpdateSnaplockConfiguration.Builder volumeAppendModeEnabled(Boolean 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.

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:

Returns a reference to this object so that method calls can be chained together.