software.amazon.awssdk.services.fsx.model

Class SnaplockConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.SnaplockConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SnaplockConfiguration.Builder,SnaplockConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class SnaplockConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SnaplockConfiguration.Builder,SnaplockConfiguration>

Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SnaplockConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	auditLogVolume() Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
AutocommitPeriod	autocommitPeriod() The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
static SnaplockConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PrivilegedDelete	privilegedDelete() Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
String	privilegedDeleteAsString() Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
SnaplockRetentionPeriod	retentionPeriod() Specifies the retention period of an FSx for ONTAP SnapLock volume.
List<SdkField<?>>	sdkFields()
static Class<? extends SnaplockConfiguration.Builder>	serializableBuilderClass()
SnaplockType	snaplockType() Specifies the retention mode of an FSx for ONTAP SnapLock volume.
String	snaplockTypeAsString() Specifies the retention mode of an FSx for ONTAP SnapLock volume.
SnaplockConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	volumeAppendModeEnabled() Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

auditLogVolume

public final 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.

Returns:

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.

autocommitPeriod

public final AutocommitPeriod autocommitPeriod()

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

Returns:

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

privilegedDelete

public final 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.

If the service returns an enum value that is not available in the current SDK version, privilegedDelete will return PrivilegedDelete.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from privilegedDeleteAsString().

Returns:

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.

See Also:

PrivilegedDelete

privilegedDeleteAsString

public final String privilegedDeleteAsString()

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.

If the service returns an enum value that is not available in the current SDK version, privilegedDelete will return PrivilegedDelete.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from privilegedDeleteAsString().

Returns:

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.

See Also:

PrivilegedDelete

retentionPeriod

public final SnaplockRetentionPeriod retentionPeriod()

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

Returns:

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

snaplockType

public final 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.

If the service returns an enum value that is not available in the current SDK version, snaplockType will return SnaplockType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snaplockTypeAsString().

Returns:

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.

See Also:

SnaplockType

snaplockTypeAsString

public final String snaplockTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, snaplockType will return SnaplockType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snaplockTypeAsString().

Returns:

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.

See Also:

SnaplockType

volumeAppendModeEnabled

public final 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.

Returns:

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.

toBuilder

public SnaplockConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnaplockConfiguration.Builder,SnaplockConfiguration>

builder

public static SnaplockConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SnaplockConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo