Package software.amazon.awssdk.services.fsx.model

Interface OpenZFSCreateRootVolumeConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OpenZFSCreateRootVolumeConfiguration.Builder,OpenZFSCreateRootVolumeConfiguration>, SdkBuilder<OpenZFSCreateRootVolumeConfiguration.Builder,OpenZFSCreateRootVolumeConfiguration>, SdkPojo
Enclosing class:
OpenZFSCreateRootVolumeConfiguration
public static interface OpenZFSCreateRootVolumeConfiguration.Builder extends SdkPojo, CopyableBuilder<OpenZFSCreateRootVolumeConfiguration.Builder,OpenZFSCreateRootVolumeConfiguration>

  • Method Details

    • recordSizeKiB

      OpenZFSCreateRootVolumeConfiguration.Builder recordSizeKiB(Integer recordSizeKiB)

      Specifies the record size of an OpenZFS root 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. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

      Parameters:
      recordSizeKiB - Specifies the record size of an OpenZFS root 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. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataCompressionType

      OpenZFSCreateRootVolumeConfiguration.Builder dataCompressionType(String 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.

      Parameters:
      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.

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

    • dataCompressionType

      OpenZFSCreateRootVolumeConfiguration.Builder dataCompressionType(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.

      Parameters:
      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.

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

    • nfsExports

      OpenZFSCreateRootVolumeConfiguration.Builder nfsExports(Collection<OpenZFSNfsExport> nfsExports)

      The configuration object for mounting a file system.

      Parameters:
      nfsExports - The configuration object for mounting a file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nfsExports

      OpenZFSCreateRootVolumeConfiguration.Builder nfsExports(OpenZFSNfsExport... nfsExports)

      The configuration object for mounting a file system.

      Parameters:
      nfsExports - The configuration object for mounting a file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nfsExports

      OpenZFSCreateRootVolumeConfiguration.Builder nfsExports(Consumer<OpenZFSNfsExport.Builder>... nfsExports)

      The configuration object for mounting a file system.

      This is a convenience method that creates an instance of the OpenZFSNfsExport.Builder avoiding the need to create one manually via OpenZFSNfsExport.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nfsExports(List<OpenZFSNfsExport>).

      Parameters:
      nfsExports - a consumer that will call methods on OpenZFSNfsExport.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userAndGroupQuotas

      OpenZFSCreateRootVolumeConfiguration.Builder userAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)

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

      Parameters:
      userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAndGroupQuotas

      OpenZFSCreateRootVolumeConfiguration.Builder userAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)

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

      Parameters:
      userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAndGroupQuotas

      OpenZFSCreateRootVolumeConfiguration.Builder userAndGroupQuotas(Consumer<OpenZFSUserOrGroupQuota.Builder>... userAndGroupQuotas)

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

      This is a convenience method that creates an instance of the OpenZFSUserOrGroupQuota.Builder avoiding the need to create one manually via OpenZFSUserOrGroupQuota.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userAndGroupQuotas(List<OpenZFSUserOrGroupQuota>).

      Parameters:
      userAndGroupQuotas - a consumer that will call methods on OpenZFSUserOrGroupQuota.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • copyTagsToSnapshots

      OpenZFSCreateRootVolumeConfiguration.Builder copyTagsToSnapshots(Boolean copyTagsToSnapshots)

      A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. 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.

      Parameters:
      copyTagsToSnapshots - A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. 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:
      Returns a reference to this object so that method calls can be chained together.

    • readOnly

      OpenZFSCreateRootVolumeConfiguration.Builder readOnly(Boolean readOnly)

      A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

      Parameters:
      readOnly - A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
      Returns:
      Returns a reference to this object so that method calls can be chained together.