We are excited to announce our new API Documentation.
The request object used to create a new Amazon FSx file system.
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.
The type of Amazon FSx file system to create. Valid values are
(Optional) For FSx for Lustre file systems, sets the Lustre version
for the file system that you're creating. Valid values are
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
2.12 and 2.15 are supported by all Lustre deployment types.
2.15 is required when setting FSx for Lustre
Default value =
2.10, except when
DeploymentType is set to
PERSISTENT_2, then the default is
If you set
2.10 for a
PERSISTENT_2 Lustre deployment type, the
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
Amazon FSx for Lustre
PERSISTENT_2 deployment types only.
SCRATCH_2 types are encrypted using
the Amazon FSx service KMS key for your account.
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used.
For more information, see Encrypt in the
Key Management Service API Reference.
The Lustre configuration for the file system being created.
The following parameters are not supported for file systems with a data repository association created with .
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
The OpenZFS configuration for the file system that's being created.
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
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
PERSISTENT_1 deployment types
using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
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.
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 depends on the value of the
HAPairs property. The minimum value is calculated as 1,024 *
HAPairs and the maxium is calculated as 524,288 *
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).
Sets the storage type for the file system that you're creating. Valid values are
SSD to use solid state drive storage. SSD is supported on all Windows,
Lustre, ONTAP, and OpenZFS deployment types.
HDD to use hard disk drive storage.
HDD is supported on
MULTI_AZ_1 Windows file system deployment types,
PERSISTENT_1 Lustre file system deployment types.
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
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
SINGLE_AZ_2 and all Lustre
deployment types, provide exactly one subnet ID.
The file server is launched in that subnet's Availability Zone.
The tags to apply to the file system that's being created. The key value of the
Name tag appears in the console as the file system name.
The Microsoft Windows configuration for the file system that's being created.