Amazonka.FSx.CreateFileSystem

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.

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.

Creating a Request

data CreateFileSystem

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

See: newCreateFileSystem smart constructor.

Constructors

CreateFileSystem'

Fields

• clientRequestToken :: Maybe Text

  A string of up to 64 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.

• fileSystemTypeVersion :: Maybe Text

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

  • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
  • 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.

  Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.

  If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

• kmsKeyId :: Maybe Text
• lustreConfiguration :: Maybe CreateFileSystemLustreConfiguration
• ontapConfiguration :: Maybe CreateFileSystemOntapConfiguration
• openZFSConfiguration :: Maybe CreateFileSystemOpenZFSConfiguration

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

• securityGroupIds :: Maybe [Text]

  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.

• storageType :: Maybe 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.

• tags :: Maybe (NonEmpty Tag)

  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.

• windowsConfiguration :: Maybe CreateFileSystemWindowsConfiguration

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

• fileSystemType :: FileSystemType

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

• storageCapacity :: Natural

  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).
• subnetIds :: [Text]

  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.

Instances

ToJSON CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

toJSON :: CreateFileSystem -> Value

toEncoding :: CreateFileSystem -> Encoding

toJSONList :: [CreateFileSystem] -> Value

toEncodingList :: [CreateFileSystem] -> Encoding

ToHeaders CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

toHeaders :: CreateFileSystem -> [Header]

ToPath CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

toPath :: CreateFileSystem -> ByteString

ToQuery CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

toQuery :: CreateFileSystem -> QueryString

AWSRequest CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Associated Types

type AWSResponse CreateFileSystem

Methods

request :: (Service -> Service) -> CreateFileSystem -> Request CreateFileSystem

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFileSystem -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFileSystem)))

Generic CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Associated Types

type Rep CreateFileSystem :: Type -> Type

Methods

from :: CreateFileSystem -> Rep CreateFileSystem x

to :: Rep CreateFileSystem x -> CreateFileSystem

Show CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

showsPrec :: Int -> CreateFileSystem -> ShowS

show :: CreateFileSystem -> String

showList :: [CreateFileSystem] -> ShowS

NFData CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

rnf :: CreateFileSystem -> ()

Eq CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

(==) :: CreateFileSystem -> CreateFileSystem -> Bool

(/=) :: CreateFileSystem -> CreateFileSystem -> Bool

Hashable CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

Methods

hashWithSalt :: Int -> CreateFileSystem -> Int

hash :: CreateFileSystem -> Int

type AWSResponse CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

type AWSResponse CreateFileSystem = CreateFileSystemResponse

type Rep CreateFileSystem

Defined in Amazonka.FSx.CreateFileSystem

type Rep CreateFileSystem = D1 ('MetaData "CreateFileSystem" "Amazonka.FSx.CreateFileSystem" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateFileSystem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fileSystemTypeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "lustreConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateFileSystemLustreConfiguration)) :*: (S1 ('MetaSel ('Just "ontapConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateFileSystemOntapConfiguration)) :*: S1 ('MetaSel ('Just "openZFSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateFileSystemOpenZFSConfiguration))))) :*: ((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageType)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))) :*: ((S1 ('MetaSel ('Just "windowsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateFileSystemWindowsConfiguration)) :*: S1 ('MetaSel ('Just "fileSystemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FileSystemType)) :*: (S1 ('MetaSel ('Just "storageCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))))

newCreateFileSystem

Arguments

:: FileSystemType

CreateFileSystem

-> Natural

CreateFileSystem

-> CreateFileSystem

Create a value of CreateFileSystem 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:clientRequestToken:CreateFileSystem', createFileSystem_clientRequestToken - A string of up to 64 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.

CreateFileSystem, createFileSystem_fileSystemTypeVersion - (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10 and 2.12:

• 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
• 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.

Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.

If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

CreateFileSystem, createFileSystem_kmsKeyId - Undocumented member.

CreateFileSystem, createFileSystem_lustreConfiguration - Undocumented member.

CreateFileSystem, createFileSystem_ontapConfiguration - Undocumented member.

CreateFileSystem, createFileSystem_openZFSConfiguration - The OpenZFS configuration for the file system that's being created.

$sel:securityGroupIds:CreateFileSystem', createFileSystem_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.

CreateFileSystem, createFileSystem_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.

CreateFileSystem, createFileSystem_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.

CreateFileSystem, createFileSystem_windowsConfiguration - The Microsoft Windows configuration for the file system that's being created.

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

CreateFileSystem, createFileSystem_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).

CreateFileSystem, createFileSystem_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.

Request Lenses

createFileSystem_clientRequestToken :: Lens' CreateFileSystem (Maybe Text)

A string of up to 64 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.

createFileSystem_fileSystemTypeVersion :: Lens' CreateFileSystem (Maybe Text)

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

• 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
• 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.

Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.

If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

createFileSystem_kmsKeyId :: Lens' CreateFileSystem (Maybe Text)

Undocumented member.

createFileSystem_lustreConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemLustreConfiguration)

Undocumented member.

createFileSystem_ontapConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemOntapConfiguration)

Undocumented member.

createFileSystem_openZFSConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemOpenZFSConfiguration)

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

createFileSystem_securityGroupIds :: Lens' CreateFileSystem (Maybe [Text])

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.

createFileSystem_storageType :: Lens' CreateFileSystem (Maybe 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.

createFileSystem_tags :: Lens' CreateFileSystem (Maybe (NonEmpty Tag))

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.

createFileSystem_windowsConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemWindowsConfiguration)

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

createFileSystem_fileSystemType :: Lens' CreateFileSystem FileSystemType

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

createFileSystem_storageCapacity :: Lens' CreateFileSystem Natural

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

createFileSystem_subnetIds :: Lens' CreateFileSystem [Text]

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.

Destructuring the Response

data CreateFileSystemResponse

The response object returned after the file system is created.

See: newCreateFileSystemResponse smart constructor.

Constructors

CreateFileSystemResponse'

Fields

• fileSystem :: Maybe FileSystem

  The configuration of the file system that was created.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateFileSystemResponse

Defined in Amazonka.FSx.CreateFileSystem

Associated Types

type Rep CreateFileSystemResponse :: Type -> Type

Methods

from :: CreateFileSystemResponse -> Rep CreateFileSystemResponse x

to :: Rep CreateFileSystemResponse x -> CreateFileSystemResponse

Read CreateFileSystemResponse

Defined in Amazonka.FSx.CreateFileSystem

Methods

readsPrec :: Int -> ReadS CreateFileSystemResponse

readList :: ReadS [CreateFileSystemResponse]

readPrec :: ReadPrec CreateFileSystemResponse

readListPrec :: ReadPrec [CreateFileSystemResponse]

Show CreateFileSystemResponse

Defined in Amazonka.FSx.CreateFileSystem

Methods

showsPrec :: Int -> CreateFileSystemResponse -> ShowS

show :: CreateFileSystemResponse -> String

showList :: [CreateFileSystemResponse] -> ShowS

NFData CreateFileSystemResponse

Defined in Amazonka.FSx.CreateFileSystem

Methods

rnf :: CreateFileSystemResponse -> ()

Eq CreateFileSystemResponse

Defined in Amazonka.FSx.CreateFileSystem

Methods

(==) :: CreateFileSystemResponse -> CreateFileSystemResponse -> Bool

(/=) :: CreateFileSystemResponse -> CreateFileSystemResponse -> Bool

type Rep CreateFileSystemResponse

Defined in Amazonka.FSx.CreateFileSystem

type Rep CreateFileSystemResponse = D1 ('MetaData "CreateFileSystemResponse" "Amazonka.FSx.CreateFileSystem" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateFileSystemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSystem)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFileSystemResponse

Arguments

:: Int

$sel:httpStatus:CreateFileSystemResponse'

-> CreateFileSystemResponse

Create a value of CreateFileSystemResponse 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:

CreateFileSystemResponse, createFileSystemResponse_fileSystem - The configuration of the file system that was created.

$sel:httpStatus:CreateFileSystemResponse', createFileSystemResponse_httpStatus - The response's http status code.

Response Lenses

createFileSystemResponse_fileSystem :: Lens' CreateFileSystemResponse (Maybe FileSystem)

The configuration of the file system that was created.

createFileSystemResponse_httpStatus :: Lens' CreateFileSystemResponse Int

The response's http status code.