The FSx for Lustre File System implementation of IFileSystem.

LustreFileSystem

Additional configuration for FSx specific to Lustre.

lustreConfiguration

The subnet that the file system will be accessible from.

vpcSubnet

fileSystemTypeVersion

The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB to 65,536 GiB.
For SCRATCH_1 deployment types, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3,600 GiB.
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.

storageCapacityGiB

The ID of the backup.

Specifies the backup to use if you're creating a file system from an existing backup.

backupId

The KMS key used for encryption to protect your data at rest.

kmsKey

Policy to apply when the file system is removed from the stack.

removalPolicy

Security Group to assign to this file system.

securityGroup

The storage type for the file system that you're creating.

storageType

Creates an Amazon FSx for Lustre data repository association (DRA).

A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding `scratch_1` deployment type.

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html) .

CfnDataRepositoryAssociation

The path to the Amazon S3 data repository that will be linked to the file system.

The path can be an S3 bucket or prefix in the format `s3://myBucket/myPrefix/` . This path specifies where in the S3 data repository files will be imported from or exported to.

dataRepositoryPath

The ID of the file system on which the data repository association is configured.

fileSystemId

A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as `/ns1/` ) or subdirectory (such as `/ns1/subdir/` ) that will be mapped 1-1 with `DataRepositoryPath` .

The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path `/ns1/` , then you cannot link another data repository with file system path `/ns1/ns2` .

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

> If you specify only a forward slash ( `/` ) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

fileSystemPath

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.

The task runs if this flag is set to `true` .

batchImportMetaDataOnCreate

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk.

The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

importedFileChunkSize

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.

The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

A list of `Tag` values, with a maximum of 50 elements.

CfnFileSystem

The type of Amazon FSx file system, which can be `LUSTRE` , `WINDOWS` , `ONTAP` , or `OPENZFS` .

fileSystemType

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](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html) in the *Amazon FSx for Windows User Guide* and [Availability and durability](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html) 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.

subnetIds

The ID of the file system backup that you are using to create a file system.

For more information, see [CreateFileSystemFromBackup](https://docs.aws.amazon.com/fsx/latest/APIReference/API_CreateFileSystemFromBackup.html) .

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.

The ID of the AWS Key Management Service ( AWS  ) key used to encrypt Amazon FSx file system data.

Used as follows with Amazon FSx file system types:

- Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment types only.

`SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon FSx service AWS  key for your account.
- Amazon FSx for NetApp ONTAP
- Amazon FSx for OpenZFS
- Amazon FSx for Windows File Server

If this ID isn't specified, the Amazon FSx-managed key for your account is used. For more information, see [Encrypt](https://docs.aws.amazon.com//kms/latest/APIReference/API_Encrypt.html) in the *AWS Key Management Service API Reference* .

kmsKeyId

The Lustre configuration for the file system being created.

This configuration is required if the `FileSystemType` is set to `LUSTRE` .

> The following parameters are not supported when creating Lustre file systems with a data repository association.
>
> - `AutoImportPolicy`
> - `ExportPath`
> - `ImportedChunkSize`
> - `ImportPath`

networkType

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

This configuration is required if the `FileSystemType` is set to `ONTAP` .

ontapConfiguration

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

This configuration is required if the `FileSystemType` is set to `OPENZFS` .

openZfsConfiguration

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.

securityGroupIds

Sets the storage capacity of the file system that you're creating.

`StorageCapacity` is required if you are creating a new file system. It is not required if you are creating a file system by restoring a backup.

*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 SSD storage capacity that you can configure depends on the value of the `HAPairs` property. The minimum value is calculated as 1,024 GiB * HAPairs and the maximum is calculated as 524,288 GiB * HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB (1 pebibyte).

*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). If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity.

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

storageCapacity

Sets the storage class for the file system that you're creating.

Valid values are `SSD` , `HDD` , and `INTELLIGENT_TIERING` .

- 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, which is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT_1` Lustre file system deployment types.
- Set to `INTELLIGENT_TIERING` to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent_2 deployment type.

Default value is `SSD` . For more information, see [Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide* , [FSx for Lustre storage classes](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-storage-classes) in the *FSx for Lustre User Guide* , and [Working with Intelligent-Tiering](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance-intelligent-tiering) in the *Amazon FSx for OpenZFS User Guide* .

The tags to associate with the file system.

For more information, see [Tagging your Amazon FSx resources](https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html) in the *Amazon FSx for Lustre User Guide* .

The configuration object for the Microsoft Windows file system you are creating.

This configuration is required if `FileSystemType` is set to `WINDOWS` .

windowsConfiguration

An S3 access point attached to an Amazon FSx volume.

CfnS3AccessPointAttachment

The name of the S3 access point attachment;

also used for the name of the S3 access point.

name

The type of Amazon FSx volume that the S3 access point is attached to.

type

The ONTAP configuration of the S3 access point attachment.

The OpenZFSConfiguration of the S3 access point attachment.

The S3 access point configuration of the S3 access point attachment.

s3AccessPoint

A snapshot of an Amazon FSx for OpenZFS volume.

CfnSnapshot

The ID of the volume that the snapshot is of.

volumeId

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

CfnStorageVirtualMachine

Specifies the FSx for ONTAP file system on which to create the SVM.

Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

activeDirectoryConfiguration

The security style of the root volume of the SVM. Specify one of the following values:.

- `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
- `NTFS` if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.
- `MIXED` This is an advanced setting. For more information, see [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html) in the Amazon FSx for NetApp ONTAP User Guide.

rootVolumeSecurityStyle

Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.

Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's `fsxadmin` user to manage the SVM. For more information, see [Managing SVMs using the NetApp ONTAP CLI](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html#vsadmin-ontap-cli) in the *FSx for ONTAP User Guide* .

svmAdminPassword

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

CfnVolume

Specifies the ID of the volume backup to use to create a new volume.

The configuration of an Amazon FSx for NetApp ONTAP volume.

The configuration of an Amazon FSx for OpenZFS volume.

An array of key-value pairs to apply to this resource.

For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

AWS fsx

L2 Constructs1

LustreFileSystem

L1 Constructs6

CfnDataRepositoryAssociation

CfnFileSystem

CfnS3AccessPointAttachment

CfnSnapshot

CfnStorageVirtualMachine

CfnVolume

Learn AWS the Practical Way

Quick Facts

Related Links

More AWS fsx deep dives