AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

LustreFileSystem

The FSx for Lustre File System implementation of IFileSystem.

Import

import { LustreFileSystem } from 'aws-cdk-lib/aws-fsx';

Or use the module namespace:

import * as fsx from 'aws-cdk-lib/aws-fsx';
// fsx.LustreFileSystem

Properties

Configuration passed to the constructor as LustreFileSystemProps.

lustreConfigurationRequired
LustreConfiguration

Additional configuration for FSx specific to Lustre.

vpcSubnetRequired
ISubnet

The subnet that the file system will be accessible from.

fileSystemTypeVersionOptional
FileSystemTypeVersion

The Lustre version for the file system.

Default: - V_2_10, except for PERSISTENT_2 deployment type, where it is V_2_12 without metadata configuration mode and V_2_15 with metadata configuration mode.

7 properties inherited from FileSystemProps
storageCapacityGiBRequiredinherited from FileSystemProps
number

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.

vpcRequiredinherited from FileSystemProps
IVpc

The VPC to launch the file system in.

backupIdOptionalinherited from FileSystemProps
string

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

Default: - no backup will be used.

kmsKeyOptionalinherited from FileSystemProps
IKeyRef

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

Default: - the aws/fsx default KMS key for the AWS account being deployed into.

removalPolicyOptionalinherited from FileSystemProps
RemovalPolicy

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

Default: RemovalPolicy.RETAIN

securityGroupOptionalinherited from FileSystemProps
ISecurityGroup

Security Group to assign to this file system.

Default: - creates new security group which allows all outbound traffic.

storageTypeOptionalinherited from FileSystemProps
StorageType

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

Default: StorageType.SSD

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter