software.amazon.awssdk.services.fsx.model

Interface CreateSnaplockConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

CreateSnaplockConfiguration

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

Method Summary

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

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

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

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

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

CreateSnaplockConfiguration.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 CreateSnaplockConfiguration.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)

snaplockType

CreateSnaplockConfiguration.Builder snaplockType(String snaplockType)

Specifies the retention mode of an FSx for ONTAP SnapLock volume. 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.

Parameters:

snaplockType - Specifies the retention mode of an FSx for ONTAP SnapLock volume. 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:

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

See Also:

SnaplockType, SnaplockType

snaplockType

CreateSnaplockConfiguration.Builder snaplockType(SnaplockType snaplockType)

Specifies the retention mode of an FSx for ONTAP SnapLock volume. 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.

Parameters:

snaplockType - Specifies the retention mode of an FSx for ONTAP SnapLock volume. 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:

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

See Also:

SnaplockType, SnaplockType

volumeAppendModeEnabled

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