Class SnaplockConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.SnaplockConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SnaplockConfiguration.Builder,SnaplockConfiguration>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SnaplockConfiguration.Builder,SnaplockConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.