amazonka-fsx-2.0: Amazon FSx SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

Description

 
Synopsis

Documentation

data OpenZFSCreateRootVolumeConfiguration Source #

The configuration of an Amazon FSx for OpenZFS root volume.

See: newOpenZFSCreateRootVolumeConfiguration smart constructor.

Constructors

OpenZFSCreateRootVolumeConfiguration' 

Fields

  • copyTagsToSnapshots :: Maybe Bool

    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.

  • 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 file system.

  • readOnly :: Maybe Bool

    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.

  • recordSizeKiB :: Maybe Natural

    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.

  • userAndGroupQuotas :: Maybe [OpenZFSUserOrGroupQuota]

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

Instances

Instances details
ToJSON OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

Generic OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

Read OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

Show OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

NFData OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

Eq OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

Hashable OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

type Rep OpenZFSCreateRootVolumeConfiguration Source # 
Instance details

Defined in Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration

type Rep OpenZFSCreateRootVolumeConfiguration = D1 ('MetaData "OpenZFSCreateRootVolumeConfiguration" "Amazonka.FSx.Types.OpenZFSCreateRootVolumeConfiguration" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "OpenZFSCreateRootVolumeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "copyTagsToSnapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (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 "userAndGroupQuotas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OpenZFSUserOrGroupQuota]))))))

newOpenZFSCreateRootVolumeConfiguration :: OpenZFSCreateRootVolumeConfiguration Source #

Create a value of OpenZFSCreateRootVolumeConfiguration 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:copyTagsToSnapshots:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_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.

$sel:dataCompressionType:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_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:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_nfsExports - The configuration object for mounting a file system.

$sel:readOnly:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_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.

$sel:recordSizeKiB:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_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.

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

openZFSCreateRootVolumeConfiguration_copyTagsToSnapshots :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool) Source #

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.

openZFSCreateRootVolumeConfiguration_dataCompressionType :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #

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.

openZFSCreateRootVolumeConfiguration_readOnly :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool) Source #

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.

openZFSCreateRootVolumeConfiguration_recordSizeKiB :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Natural) Source #

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.

openZFSCreateRootVolumeConfiguration_userAndGroupQuotas :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #

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