/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace FSx { namespace Model { /** *

The configuration of an Amazon FSx for OpenZFS root volume.

See * Also:

AWS * API Reference

*/ class OpenZFSCreateRootVolumeConfiguration { public: AWS_FSX_API OpenZFSCreateRootVolumeConfiguration(); AWS_FSX_API OpenZFSCreateRootVolumeConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_FSX_API OpenZFSCreateRootVolumeConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_FSX_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline int GetRecordSizeKiB() const{ return m_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.

*/ inline bool RecordSizeKiBHasBeenSet() const { return m_recordSizeKiBHasBeenSet; } /** *

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.

*/ inline void SetRecordSizeKiB(int value) { m_recordSizeKiBHasBeenSet = true; m_recordSizeKiB = value; } /** *

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.

*/ inline OpenZFSCreateRootVolumeConfiguration& WithRecordSizeKiB(int value) { SetRecordSizeKiB(value); return *this;} /** *

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.

*/ inline const OpenZFSDataCompressionType& GetDataCompressionType() const{ return m_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.

*/ inline bool DataCompressionTypeHasBeenSet() const { return m_dataCompressionTypeHasBeenSet; } /** *

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.

*/ inline void SetDataCompressionType(const OpenZFSDataCompressionType& value) { m_dataCompressionTypeHasBeenSet = true; m_dataCompressionType = value; } /** *

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.

*/ inline void SetDataCompressionType(OpenZFSDataCompressionType&& value) { m_dataCompressionTypeHasBeenSet = true; m_dataCompressionType = std::move(value); } /** *

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.

*/ inline OpenZFSCreateRootVolumeConfiguration& WithDataCompressionType(const OpenZFSDataCompressionType& value) { SetDataCompressionType(value); return *this;} /** *

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.

*/ inline OpenZFSCreateRootVolumeConfiguration& WithDataCompressionType(OpenZFSDataCompressionType&& value) { SetDataCompressionType(std::move(value)); return *this;} /** *

The configuration object for mounting a file system.

*/ inline const Aws::Vector& GetNfsExports() const{ return m_nfsExports; } /** *

The configuration object for mounting a file system.

*/ inline bool NfsExportsHasBeenSet() const { return m_nfsExportsHasBeenSet; } /** *

The configuration object for mounting a file system.

*/ inline void SetNfsExports(const Aws::Vector& value) { m_nfsExportsHasBeenSet = true; m_nfsExports = value; } /** *

The configuration object for mounting a file system.

*/ inline void SetNfsExports(Aws::Vector&& value) { m_nfsExportsHasBeenSet = true; m_nfsExports = std::move(value); } /** *

The configuration object for mounting a file system.

*/ inline OpenZFSCreateRootVolumeConfiguration& WithNfsExports(const Aws::Vector& value) { SetNfsExports(value); return *this;} /** *

The configuration object for mounting a file system.

*/ inline OpenZFSCreateRootVolumeConfiguration& WithNfsExports(Aws::Vector&& value) { SetNfsExports(std::move(value)); return *this;} /** *

The configuration object for mounting a file system.

*/ inline OpenZFSCreateRootVolumeConfiguration& AddNfsExports(const OpenZFSNfsExport& value) { m_nfsExportsHasBeenSet = true; m_nfsExports.push_back(value); return *this; } /** *

The configuration object for mounting a file system.

*/ inline OpenZFSCreateRootVolumeConfiguration& AddNfsExports(OpenZFSNfsExport&& value) { m_nfsExportsHasBeenSet = true; m_nfsExports.push_back(std::move(value)); return *this; } /** *

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

*/ inline const Aws::Vector& GetUserAndGroupQuotas() const{ return m_userAndGroupQuotas; } /** *

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

*/ inline bool UserAndGroupQuotasHasBeenSet() const { return m_userAndGroupQuotasHasBeenSet; } /** *

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

*/ inline void SetUserAndGroupQuotas(const Aws::Vector& value) { m_userAndGroupQuotasHasBeenSet = true; m_userAndGroupQuotas = value; } /** *

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

*/ inline void SetUserAndGroupQuotas(Aws::Vector&& value) { m_userAndGroupQuotasHasBeenSet = true; m_userAndGroupQuotas = std::move(value); } /** *

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

*/ inline OpenZFSCreateRootVolumeConfiguration& WithUserAndGroupQuotas(const Aws::Vector& value) { SetUserAndGroupQuotas(value); return *this;} /** *

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

*/ inline OpenZFSCreateRootVolumeConfiguration& WithUserAndGroupQuotas(Aws::Vector&& value) { SetUserAndGroupQuotas(std::move(value)); return *this;} /** *

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

*/ inline OpenZFSCreateRootVolumeConfiguration& AddUserAndGroupQuotas(const OpenZFSUserOrGroupQuota& value) { m_userAndGroupQuotasHasBeenSet = true; m_userAndGroupQuotas.push_back(value); return *this; } /** *

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

*/ inline OpenZFSCreateRootVolumeConfiguration& AddUserAndGroupQuotas(OpenZFSUserOrGroupQuota&& value) { m_userAndGroupQuotasHasBeenSet = true; m_userAndGroupQuotas.push_back(std::move(value)); return *this; } /** *

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.

*/ inline bool GetCopyTagsToSnapshots() const{ return m_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.

*/ inline bool CopyTagsToSnapshotsHasBeenSet() const { return m_copyTagsToSnapshotsHasBeenSet; } /** *

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.

*/ inline void SetCopyTagsToSnapshots(bool value) { m_copyTagsToSnapshotsHasBeenSet = true; m_copyTagsToSnapshots = value; } /** *

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.

*/ inline OpenZFSCreateRootVolumeConfiguration& WithCopyTagsToSnapshots(bool value) { SetCopyTagsToSnapshots(value); return *this;} /** *

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.

*/ inline bool GetReadOnly() const{ return m_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.

*/ inline bool ReadOnlyHasBeenSet() const { return m_readOnlyHasBeenSet; } /** *

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.

*/ inline void SetReadOnly(bool value) { m_readOnlyHasBeenSet = true; m_readOnly = value; } /** *

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.

*/ inline OpenZFSCreateRootVolumeConfiguration& WithReadOnly(bool value) { SetReadOnly(value); return *this;} private: int m_recordSizeKiB; bool m_recordSizeKiBHasBeenSet = false; OpenZFSDataCompressionType m_dataCompressionType; bool m_dataCompressionTypeHasBeenSet = false; Aws::Vector m_nfsExports; bool m_nfsExportsHasBeenSet = false; Aws::Vector m_userAndGroupQuotas; bool m_userAndGroupQuotasHasBeenSet = false; bool m_copyTagsToSnapshots; bool m_copyTagsToSnapshotsHasBeenSet = false; bool m_readOnly; bool m_readOnlyHasBeenSet = false; }; } // namespace Model } // namespace FSx } // namespace Aws