Class OpenZFSVolumeConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.OpenZFSVolumeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OpenZFSVolumeConfiguration.Builder,OpenZFSVolumeConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class OpenZFSVolumeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OpenZFSVolumeConfiguration.Builder,OpenZFSVolumeConfiguration>

The configuration of an Amazon FSx for OpenZFS volume.

See Also:

  • Method Details

    • parentVolumeId

      public final String parentVolumeId()

      The ID of the parent volume.

      Returns:
      The ID of the parent volume.

    • volumePath

      public final String volumePath()

      The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

      Returns:
      The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

    • storageCapacityReservationGiB

      public final Integer storageCapacityReservationGiB()

      The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

      Returns:
      The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

    • storageCapacityQuotaGiB

      public final Integer storageCapacityQuotaGiB()

      The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

      Returns:
      The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

    • recordSizeKiB

      public final Integer recordSizeKiB()

      The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

      Returns:
      The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

    • dataCompressionType

      public final OpenZFSDataCompressionType dataCompressionType()

      Specifies the method used to compress the data on the volume. The compression type is NONE by default.

      • NONE - Doesn't compress the data on the volume. NONE is the default.

      • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

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

      Returns:
      Specifies the method used to compress the data on the volume. The compression type is NONE by default.

      • NONE - Doesn't compress the data on the volume. NONE is the default.

      • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

      See Also:

    • dataCompressionTypeAsString

      public final String dataCompressionTypeAsString()

      Specifies the method used to compress the data on the volume. The compression type is NONE by default.

      • NONE - Doesn't compress the data on the volume. NONE is the default.

      • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

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

      Returns:
      Specifies the method used to compress the data on the volume. The compression type is NONE by default.

      • NONE - Doesn't compress the data on the volume. NONE is the default.

      • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

      See Also:

    • copyTagsToSnapshots

      public final Boolean copyTagsToSnapshots()

      A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

      Returns:
      A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

    • originSnapshot

      public final OpenZFSOriginSnapshotConfiguration originSnapshot()

      The configuration object that specifies the snapshot to use as the origin of the data for the volume.

      Returns:
      The configuration object that specifies the snapshot to use as the origin of the data for the volume.

    • readOnly

      public final Boolean readOnly()

      A Boolean value indicating whether the volume is read-only.

      Returns:
      A Boolean value indicating whether the volume is read-only.

    • hasNfsExports

      public final boolean hasNfsExports()
      For responses, this returns true if the service returned a value for the NfsExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • nfsExports

      public final List<OpenZFSNfsExport> nfsExports()

      The configuration object for mounting a Network File System (NFS) file system.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNfsExports() method.

      Returns:
      The configuration object for mounting a Network File System (NFS) file system.

    • hasUserAndGroupQuotas

      public final boolean hasUserAndGroupQuotas()
      For responses, this returns true if the service returned a value for the UserAndGroupQuotas property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • userAndGroupQuotas

      public final List<OpenZFSUserOrGroupQuota> userAndGroupQuotas()

      An object specifying how much storage users or groups can use on the volume.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserAndGroupQuotas() method.

      Returns:
      An object specifying how much storage users or groups can use on the volume.

    • restoreToSnapshot

      public final String restoreToSnapshot()

      Specifies the ID of the snapshot to which the volume was restored.

      Returns:
      Specifies the ID of the snapshot to which the volume was restored.

    • deleteIntermediateSnaphots

      public final Boolean deleteIntermediateSnaphots()

      A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

      Returns:
      A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

    • deleteClonedVolumes

      public final Boolean deleteClonedVolumes()

      A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

      Returns:
      A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

    • deleteIntermediateData

      public final Boolean deleteIntermediateData()

      A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

      Returns:
      A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

    • sourceSnapshotARN

      public final String sourceSnapshotARN()
      Returns the value of the SourceSnapshotARN property for this object.
      Returns:
      The value of the SourceSnapshotARN property for this object.

    • destinationSnapshot

      public final String destinationSnapshot()

      The ID of the snapshot that's being copied or was most recently copied to the destination volume.

      Returns:
      The ID of the snapshot that's being copied or was most recently copied to the destination volume.

    • copyStrategy

      public final OpenZFSCopyStrategy copyStrategy()

      Specifies the strategy used when copying data from the snapshot to the new volume.

      • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

      • FULL_COPY - Copies all data from the snapshot to the new volume.

        Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

      The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

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

      Returns:
      Specifies the strategy used when copying data from the snapshot to the new volume.

      • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

      • FULL_COPY - Copies all data from the snapshot to the new volume.

        Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

      The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

      See Also:

    • copyStrategyAsString

      public final String copyStrategyAsString()

      Specifies the strategy used when copying data from the snapshot to the new volume.

      • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

      • FULL_COPY - Copies all data from the snapshot to the new volume.

        Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

      The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

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

      Returns:
      Specifies the strategy used when copying data from the snapshot to the new volume.

      • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

      • FULL_COPY - Copies all data from the snapshot to the new volume.

        Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

      The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

      See Also:

    • toBuilder

      public OpenZFSVolumeConfiguration.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<OpenZFSVolumeConfiguration.Builder,OpenZFSVolumeConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OpenZFSVolumeConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OpenZFSVolumeConfiguration.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.