Class CreateOpenZFSVolumeConfiguration

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

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

See Also:

  • Method Details

    • parentVolumeId

      public final String parentVolumeId()

      The ID of the volume to use as the parent volume of the volume that you are creating.

      Returns:
      The ID of the volume to use as the parent volume of the volume that you are creating.

    • storageCapacityReservationGiB

      public final Integer storageCapacityReservationGiB()

      Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

      Returns:
      Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

    • storageCapacityQuotaGiB

      public final Integer storageCapacityQuotaGiB()

      Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.

      For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

      Returns:
      Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.

      For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

    • recordSizeKiB

      public final Integer recordSizeKiB()

      Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide.

      Returns:
      Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in 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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

      For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

      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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

      For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

      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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

      For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

      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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.

      • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

      For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

      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 this value is set to true, and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true, and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original 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 this value is set to true, and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true, and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.

    • originSnapshot

      public final CreateOpenZFSOriginSnapshotConfiguration 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()

      Configures how much storage users and 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:
      Configures how much storage users and groups can use on the volume.

    • toBuilder

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

    • builder

      public static CreateOpenZFSVolumeConfiguration.Builder builder()

    • serializableBuilderClass

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