Table of Contents

Class CreateFileSystemRequest

Namespace
Amazon.FSx.Model
Assembly
AWSSDK.FSx.dll

Container for the parameters to the CreateFileSystem operation. Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

  • Amazon FSx for Lustre

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

  • Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system in JSON format.

note

The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. 

public class CreateFileSystemRequest : AmazonFSxRequest
Inheritance
CreateFileSystemRequest

Constructors

CreateFileSystemRequest() 

public CreateFileSystemRequest()

Properties

ClientRequestToken

Gets and sets the property ClientRequestToken.

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. 

public string ClientRequestToken { get; set; }

Property Value

string

FileSystemType

Gets and sets the property FileSystemType.

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

public FileSystemType FileSystemType { get; set; }

Property Value

FileSystemType

FileSystemTypeVersion

Gets and sets the property FileSystemTypeVersion.

For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:

  • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.

  • 2.12 is supported by all Lustre deployment types, except for PERSISTENT_2 with a metadata configuration mode.

  • 2.15 is supported by all Lustre deployment types and is recommended for all new file systems.

Default value is 2.10, except for the following deployments:

  • Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.

  • Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with a metadata configuration mode. 

public string FileSystemTypeVersion { get; set; }

Property Value

string

KmsKeyId

Gets and sets the property KmsKeyId.

public string KmsKeyId { get; set; }

Property Value

string

LustreConfiguration

Gets and sets the property LustreConfiguration.

public CreateFileSystemLustreConfiguration LustreConfiguration { get; set; }

Property Value

CreateFileSystemLustreConfiguration

OntapConfiguration

Gets and sets the property OntapConfiguration.

public CreateFileSystemOntapConfiguration OntapConfiguration { get; set; }

Property Value

CreateFileSystemOntapConfiguration

OpenZFSConfiguration

Gets and sets the property OpenZFSConfiguration.

The OpenZFS configuration for the file system that's being created. 

public CreateFileSystemOpenZFSConfiguration OpenZFSConfiguration { get; set; }

Property Value

CreateFileSystemOpenZFSConfiguration

SecurityGroupIds

Gets and sets the property SecurityGroupIds.

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.

You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you. 

public List<string> SecurityGroupIds { get; set; }

Property Value

List<string>

StorageCapacity

Gets and sets the property 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 depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

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). 

public int StorageCapacity { get; set; }

Property Value

int

StorageType

Gets and sets the property 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. 

public StorageType StorageType { get; set; }

Property Value

StorageType

SubnetIds

Gets and sets the property SubnetIds.

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. 

public List<string> SubnetIds { get; set; }

Property Value

List<string>

Tags

Gets and sets the property Tags.

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. 

public List<Tag> Tags { get; set; }

Property Value

List<Tag>

WindowsConfiguration

Gets and sets the property WindowsConfiguration.

The Microsoft Windows configuration for the file system that's being created. 

public CreateFileSystemWindowsConfiguration WindowsConfiguration { get; set; }

Property Value

CreateFileSystemWindowsConfiguration