Documentation

The configuration for the Amazon FSx for Lustre file system.

See: newLustreFileSystemConfiguration smart constructor.

Create a value of LustreFileSystemConfiguration 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:automaticBackupRetentionDays:LustreFileSystemConfiguration', lustreFileSystemConfiguration_automaticBackupRetentionDays - Undocumented member.

$sel:copyTagsToBackups:LustreFileSystemConfiguration', lustreFileSystemConfiguration_copyTagsToBackups - A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

$sel:dailyAutomaticBackupStartTime:LustreFileSystemConfiguration', lustreFileSystemConfiguration_dailyAutomaticBackupStartTime - Undocumented member.

$sel:dataCompressionType:LustreFileSystemConfiguration', lustreFileSystemConfiguration_dataCompressionType - The data compression configuration for the file system. DataCompressionType can have the following values:

• NONE - Data compression is turned off for the file system.
• LZ4 - Data compression is turned on with the LZ4 algorithm.

For more information, see Lustre data compression.

$sel:dataRepositoryConfiguration:LustreFileSystemConfiguration', lustreFileSystemConfiguration_dataRepositoryConfiguration - Undocumented member.

$sel:deploymentType:LustreFileSystemConfiguration', lustreFileSystemConfiguration_deploymentType - The deployment type of the FSx for Lustre file system. /Scratch deployment type/ is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 is built on Lustre v2.12 and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

The default is SCRATCH_1.

$sel:driveCacheType:LustreFileSystemConfiguration', lustreFileSystemConfiguration_driveCacheType - The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

This parameter is required when StorageType is set to HDD.

$sel:logConfiguration:LustreFileSystemConfiguration', lustreFileSystemConfiguration_logConfiguration - The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

$sel:mountName:LustreFileSystemConfiguration', lustreFileSystemConfiguration_mountName - You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

$sel:perUnitStorageThroughput:LustreFileSystemConfiguration', lustreFileSystemConfiguration_perUnitStorageThroughput - Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

Valid values:

• For PERSISTENT_1 SSD storage: 50, 100, 200.
• For PERSISTENT_1 HDD storage: 12, 40.
• For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

$sel:rootSquashConfiguration:LustreFileSystemConfiguration', lustreFileSystemConfiguration_rootSquashConfiguration - The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

$sel:weeklyMaintenanceStartTime:LustreFileSystemConfiguration', lustreFileSystemConfiguration_weeklyMaintenanceStartTime - The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

Undocumented member.

A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

Undocumented member.

The data compression configuration for the file system. DataCompressionType can have the following values:

• NONE - Data compression is turned off for the file system.
• LZ4 - Data compression is turned on with the LZ4 algorithm.

For more information, see Lustre data compression.

Undocumented member.

The deployment type of the FSx for Lustre file system. /Scratch deployment type/ is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 is built on Lustre v2.12 and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

The default is SCRATCH_1.

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

This parameter is required when StorageType is set to HDD.

The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

Valid values:

• For PERSISTENT_1 SSD storage: 50, 100, 200.
• For PERSISTENT_1 HDD storage: 12, 40.
• For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.