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

The request object used to create a new Amazon FSx file system.

See * Also:

AWS * API Reference

*/ class CreateFileSystemRequest : public FSxRequest { public: AWS_FSX_API CreateFileSystemRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateFileSystem"; } AWS_FSX_API Aws::String SerializePayload() const override; AWS_FSX_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A string of up to 63 ASCII characters that Amazon FSx uses to ensure * idempotent creation. This string is automatically filled on your behalf when you * use the Command Line Interface (CLI) or an Amazon Web Services SDK.

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

*/ inline CreateFileSystemRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

*/ inline CreateFileSystemRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

*/ inline CreateFileSystemRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} /** *

The type of Amazon FSx file system to create. Valid values are * WINDOWS, LUSTRE, ONTAP, and * OPENZFS.

*/ inline const FileSystemType& GetFileSystemType() const{ return m_fileSystemType; } /** *

The type of Amazon FSx file system to create. Valid values are * WINDOWS, LUSTRE, ONTAP, and * OPENZFS.

*/ inline bool FileSystemTypeHasBeenSet() const { return m_fileSystemTypeHasBeenSet; } /** *

The type of Amazon FSx file system to create. Valid values are * WINDOWS, LUSTRE, ONTAP, and * OPENZFS.

*/ inline void SetFileSystemType(const FileSystemType& value) { m_fileSystemTypeHasBeenSet = true; m_fileSystemType = value; } /** *

The type of Amazon FSx file system to create. Valid values are * WINDOWS, LUSTRE, ONTAP, and * OPENZFS.

*/ inline void SetFileSystemType(FileSystemType&& value) { m_fileSystemTypeHasBeenSet = true; m_fileSystemType = std::move(value); } /** *

The type of Amazon FSx file system to create. Valid values are * WINDOWS, LUSTRE, ONTAP, and * OPENZFS.

*/ inline CreateFileSystemRequest& WithFileSystemType(const FileSystemType& value) { SetFileSystemType(value); return *this;} /** *

The type of Amazon FSx file system to create. Valid values are * WINDOWS, LUSTRE, ONTAP, and * OPENZFS.

*/ inline CreateFileSystemRequest& WithFileSystemType(FileSystemType&& value) { SetFileSystemType(std::move(value)); return *this;} /** *

Sets the storage capacity of the file system that you're creating, in * gibibytes (GiB).

FSx for Lustre file systems - The amount of * storage capacity that you can configure depends on the value that you set for * StorageType and the Lustre DeploymentType, as * follows:

For SCRATCH_2, PERSISTENT_2 * and PERSISTENT_1 deployment types using SSD storage type, the valid * values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For * PERSISTENT_1 HDD file systems, valid values are increments of 6000 * GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file * systems.
For SCRATCH_1 deployment type, valid * values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

* FSx for ONTAP file systems - The amount of storage capacity that you can * configure is from 1024 GiB up to 196,608 GiB (192 TiB).

FSx for * OpenZFS file systems - The amount of storage capacity that you can configure * is from 64 GiB up to 524,288 GiB (512 TiB).

FSx for Windows File * Server file systems - The amount of storage capacity that you can configure * depends on the value that you set for StorageType as follows:

For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
*
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 * TiB).

*/ inline int GetStorageCapacity() const{ return m_storageCapacity; } /** *

Sets the storage capacity of the file system that you're creating, in * gibibytes (GiB).

FSx for Lustre file systems - The amount of * storage capacity that you can configure depends on the value that you set for * StorageType and the Lustre DeploymentType, as * follows:

For SCRATCH_2, PERSISTENT_2 * and PERSISTENT_1 deployment types using SSD storage type, the valid * values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For * PERSISTENT_1 HDD file systems, valid values are increments of 6000 * GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file * systems.
For SCRATCH_1 deployment type, valid * values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

* FSx for ONTAP file systems - The amount of storage capacity that you can * configure is from 1024 GiB up to 196,608 GiB (192 TiB).

FSx for * OpenZFS file systems - The amount of storage capacity that you can configure * is from 64 GiB up to 524,288 GiB (512 TiB).

FSx for Windows File * Server file systems - The amount of storage capacity that you can configure * depends on the value that you set for StorageType as follows:

For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
*
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 * TiB).

*/ inline bool StorageCapacityHasBeenSet() const { return m_storageCapacityHasBeenSet; } /** *

Sets the storage capacity of the file system that you're creating, in * gibibytes (GiB).

FSx for Lustre file systems - The amount of * storage capacity that you can configure depends on the value that you set for * StorageType and the Lustre DeploymentType, as * follows:

For SCRATCH_2, PERSISTENT_2 * and PERSISTENT_1 deployment types using SSD storage type, the valid * values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For * PERSISTENT_1 HDD file systems, valid values are increments of 6000 * GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file * systems.
For SCRATCH_1 deployment type, valid * values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

* FSx for ONTAP file systems - The amount of storage capacity that you can * configure is from 1024 GiB up to 196,608 GiB (192 TiB).

FSx for * OpenZFS file systems - The amount of storage capacity that you can configure * is from 64 GiB up to 524,288 GiB (512 TiB).

FSx for Windows File * Server file systems - The amount of storage capacity that you can configure * depends on the value that you set for StorageType as follows:

For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
*
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 * TiB).

*/ inline void SetStorageCapacity(int value) { m_storageCapacityHasBeenSet = true; m_storageCapacity = value; } /** *

Sets the storage capacity of the file system that you're creating, in * gibibytes (GiB).

FSx for Lustre file systems - The amount of * storage capacity that you can configure depends on the value that you set for * StorageType and the Lustre DeploymentType, as * follows:

For SCRATCH_2, PERSISTENT_2 * and PERSISTENT_1 deployment types using SSD storage type, the valid * values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For * PERSISTENT_1 HDD file systems, valid values are increments of 6000 * GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file * systems.
For SCRATCH_1 deployment type, valid * values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

* FSx for ONTAP file systems - The amount of storage capacity that you can * configure is from 1024 GiB up to 196,608 GiB (192 TiB).

FSx for * OpenZFS file systems - The amount of storage capacity that you can configure * is from 64 GiB up to 524,288 GiB (512 TiB).

FSx for Windows File * Server file systems - The amount of storage capacity that you can configure * depends on the value that you set for StorageType as follows:

For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
*
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 * TiB).

*/ inline CreateFileSystemRequest& WithStorageCapacity(int value) { SetStorageCapacity(value); return *this;} /** *

Sets the storage type for the file system that you're creating. Valid values * are SSD and HDD.

Set to * SSD to use solid state drive storage. SSD is supported on all * Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to * HDD to use hard disk drive storage. HDD is supported on * SINGLE_AZ_2 and MULTI_AZ_1 Windows file system * deployment types, and on PERSISTENT_1 Lustre file system deployment * types.

Default value is SSD. For more * information, see * Storage type options in the FSx for Windows File Server User Guide * and Multiple * storage options in the FSx for Lustre User Guide.

*/ inline const StorageType& GetStorageType() const{ return m_storageType; } /** *

Sets the storage type for the file system that you're creating. Valid values * are SSD and HDD.

Set to * SSD to use solid state drive storage. SSD is supported on all * Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to * HDD to use hard disk drive storage. HDD is supported on * SINGLE_AZ_2 and MULTI_AZ_1 Windows file system * deployment types, and on PERSISTENT_1 Lustre file system deployment * types.

Default value is SSD. For more * information, see * Storage type options in the FSx for Windows File Server User Guide * and Multiple * storage options in the FSx for Lustre User Guide.

*/ inline bool StorageTypeHasBeenSet() const { return m_storageTypeHasBeenSet; } /** *

Sets the storage type for the file system that you're creating. Valid values * are SSD and HDD.

Set to * SSD to use solid state drive storage. SSD is supported on all * Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to * HDD to use hard disk drive storage. HDD is supported on * SINGLE_AZ_2 and MULTI_AZ_1 Windows file system * deployment types, and on PERSISTENT_1 Lustre file system deployment * types.

Default value is SSD. For more * information, see * Storage type options in the FSx for Windows File Server User Guide * and Multiple * storage options in the FSx for Lustre User Guide.

*/ inline void SetStorageType(const StorageType& value) { m_storageTypeHasBeenSet = true; m_storageType = value; } /** *

Sets the storage type for the file system that you're creating. Valid values * are SSD and HDD.

Set to * SSD to use solid state drive storage. SSD is supported on all * Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to * HDD to use hard disk drive storage. HDD is supported on * SINGLE_AZ_2 and MULTI_AZ_1 Windows file system * deployment types, and on PERSISTENT_1 Lustre file system deployment * types.

Default value is SSD. For more * information, see * Storage type options in the FSx for Windows File Server User Guide * and Multiple * storage options in the FSx for Lustre User Guide.

*/ inline void SetStorageType(StorageType&& value) { m_storageTypeHasBeenSet = true; m_storageType = std::move(value); } /** *

Sets the storage type for the file system that you're creating. Valid values * are SSD and HDD.

Set to * SSD to use solid state drive storage. SSD is supported on all * Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to * HDD to use hard disk drive storage. HDD is supported on * SINGLE_AZ_2 and MULTI_AZ_1 Windows file system * deployment types, and on PERSISTENT_1 Lustre file system deployment * types.

Default value is SSD. For more * information, see * Storage type options in the FSx for Windows File Server User Guide * and Multiple * storage options in the FSx for Lustre User Guide.

*/ inline CreateFileSystemRequest& WithStorageType(const StorageType& value) { SetStorageType(value); return *this;} /** *

Sets the storage type for the file system that you're creating. Valid values * are SSD and HDD.

Set to * SSD to use solid state drive storage. SSD is supported on all * Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to * HDD to use hard disk drive storage. HDD is supported on * SINGLE_AZ_2 and MULTI_AZ_1 Windows file system * deployment types, and on PERSISTENT_1 Lustre file system deployment * types.

Default value is SSD. For more * information, see * Storage type options in the FSx for Windows File Server User Guide * and Multiple * storage options in the FSx for Lustre User Guide.

*/ inline CreateFileSystemRequest& WithStorageType(StorageType&& value) { SetStorageType(std::move(value)); return *this;} /** *

Specifies the IDs of the subnets that the file system will be accessible * from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide * exactly two subnet IDs, one for the preferred file server and one for the * standby file server. You specify one of these subnets as the preferred subnet * using the WindowsConfiguration > PreferredSubnetID or * OntapConfiguration > PreferredSubnetID properties. For more * information about Multi-AZ file system configuration, see * Availability and durability: Single-AZ and Multi-AZ file systems in the * Amazon FSx for Windows User Guide and * Availability and durability in the Amazon FSx for ONTAP User * Guide.

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline const Aws::Vector& GetSubnetIds() const{ return m_subnetIds; } /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline bool SubnetIdsHasBeenSet() const { return m_subnetIdsHasBeenSet; } /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline void SetSubnetIds(const Aws::Vector& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = value; } /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline void SetSubnetIds(Aws::Vector&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = std::move(value); } /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline CreateFileSystemRequest& WithSubnetIds(const Aws::Vector& value) { SetSubnetIds(value); return *this;} /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline CreateFileSystemRequest& WithSubnetIds(Aws::Vector&& value) { SetSubnetIds(std::move(value)); return *this;} /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline CreateFileSystemRequest& AddSubnetIds(const Aws::String& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline CreateFileSystemRequest& AddSubnetIds(Aws::String&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(std::move(value)); return *this; } /** *

For Windows SINGLE_AZ_1 and * SINGLE_AZ_2 and all Lustre deployment types, provide exactly one * subnet ID. The file server is launched in that subnet's Availability Zone.

*/ inline CreateFileSystemRequest& AddSubnetIds(const char* value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } /** *