Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Documentation

data UpdateOpenZFSVolumeConfiguration

Used to specify changes to the OpenZFS configuration for the volume that you are updating.

See: newUpdateOpenZFSVolumeConfiguration smart constructor.

Constructors

UpdateOpenZFSVolumeConfiguration'

Fields

• dataCompressionType :: Maybe OpenZFSDataCompressionType

  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.
• nfsExports :: Maybe [OpenZFSNfsExport]

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

• readOnly :: Maybe Bool

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

• recordSizeKiB :: Maybe Natural

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

• storageCapacityQuotaGiB :: Maybe Int

  The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

• storageCapacityReservationGiB :: Maybe Int

  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. You can specify a value of -1 to unset a volume's storage capacity reservation.

• userAndGroupQuotas :: Maybe [OpenZFSUserOrGroupQuota]

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

Instances

ToJSON UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Methods

toJSON :: UpdateOpenZFSVolumeConfiguration -> Value

toEncoding :: UpdateOpenZFSVolumeConfiguration -> Encoding

toJSONList :: [UpdateOpenZFSVolumeConfiguration] -> Value

toEncodingList :: [UpdateOpenZFSVolumeConfiguration] -> Encoding

Generic UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Associated Types

type Rep UpdateOpenZFSVolumeConfiguration :: Type -> Type

Methods

from :: UpdateOpenZFSVolumeConfiguration -> Rep UpdateOpenZFSVolumeConfiguration x

to :: Rep UpdateOpenZFSVolumeConfiguration x -> UpdateOpenZFSVolumeConfiguration

Read UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Methods

readsPrec :: Int -> ReadS UpdateOpenZFSVolumeConfiguration

readList :: ReadS [UpdateOpenZFSVolumeConfiguration]

readPrec :: ReadPrec UpdateOpenZFSVolumeConfiguration

readListPrec :: ReadPrec [UpdateOpenZFSVolumeConfiguration]

Show UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Methods

showsPrec :: Int -> UpdateOpenZFSVolumeConfiguration -> ShowS

show :: UpdateOpenZFSVolumeConfiguration -> String

showList :: [UpdateOpenZFSVolumeConfiguration] -> ShowS

NFData UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Methods

rnf :: UpdateOpenZFSVolumeConfiguration -> ()

Eq UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Methods

(==) :: UpdateOpenZFSVolumeConfiguration -> UpdateOpenZFSVolumeConfiguration -> Bool

(/=) :: UpdateOpenZFSVolumeConfiguration -> UpdateOpenZFSVolumeConfiguration -> Bool

Hashable UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

Methods

hashWithSalt :: Int -> UpdateOpenZFSVolumeConfiguration -> Int

hash :: UpdateOpenZFSVolumeConfiguration -> Int

type Rep UpdateOpenZFSVolumeConfiguration

Defined in Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration

type Rep UpdateOpenZFSVolumeConfiguration = D1 ('MetaData "UpdateOpenZFSVolumeConfiguration" "Amazonka.FSx.Types.UpdateOpenZFSVolumeConfiguration" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "UpdateOpenZFSVolumeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataCompressionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenZFSDataCompressionType)) :*: (S1 ('MetaSel ('Just "nfsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OpenZFSNfsExport])) :*: S1 ('MetaSel ('Just "readOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "recordSizeKiB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "storageCapacityQuotaGiB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "storageCapacityReservationGiB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "userAndGroupQuotas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OpenZFSUserOrGroupQuota]))))))

newUpdateOpenZFSVolumeConfiguration :: UpdateOpenZFSVolumeConfiguration

Create a value of UpdateOpenZFSVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataCompressionType:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_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.

$sel:nfsExports:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_nfsExports - The configuration object for mounting a Network File System (NFS) file system.

$sel:readOnly:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_readOnly - A Boolean value indicating whether the volume is read-only.

$sel:recordSizeKiB:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_recordSizeKiB - Specifies 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. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

UpdateOpenZFSVolumeConfiguration, updateOpenZFSVolumeConfiguration_storageCapacityQuotaGiB - The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

$sel:storageCapacityReservationGiB:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_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. You can specify a value of -1 to unset a volume's storage capacity reservation.

$sel:userAndGroupQuotas:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.

updateOpenZFSVolumeConfiguration_dataCompressionType :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType)

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.

updateOpenZFSVolumeConfiguration_nfsExports :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport])

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

updateOpenZFSVolumeConfiguration_readOnly :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Bool)

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

updateOpenZFSVolumeConfiguration_recordSizeKiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Natural)

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

updateOpenZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int)

The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

updateOpenZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int)

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. You can specify a value of -1 to unset a volume's storage capacity reservation.

updateOpenZFSVolumeConfiguration_userAndGroupQuotas :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota])

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