# LustreFileSystemProps

Properties specific to the Lustre version of the FSx file system.

Extends: LustreFileSystemProps
Extends: FileSystemProps
Used as props by: LustreFileSystem

- Source: [`aws-fsx/lib/lustre-file-system.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-fsx/lib/lustre-file-system.ts#L228)
- Type last changed: v2.163.0 · 22 Oct 2024

## Example

```ts
import { aws_s3 as s3 } from 'aws-cdk-lib';

declare const vpc: ec2.Vpc;
declare const bucket: s3.Bucket;

const lustreConfiguration = {
  deploymentType: fsx.LustreDeploymentType.SCRATCH_2,
  exportPath: bucket.s3UrlForObject(),
  importPath: bucket.s3UrlForObject(),
  autoImportPolicy: fsx.LustreAutoImportPolicy.NEW_CHANGED_DELETED,
};

const fs = new fsx.LustreFileSystem(this, "FsxLustreFileSystem", {
  vpc: vpc,
  vpcSubnet: vpc.privateSubnets[0],
  storageCapacityGiB: 1200,
  lustreConfiguration,
});
```

## Properties

- `backupId`: string = no backup will be used. — The ID of the backup.

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

- `fileSystemTypeVersion`: [FileSystemTypeVersion](/cdk/api/v2/docs/aws-cdk-lib.aws_fsx.FileSystemTypeVersion.html) = 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. — 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.

- `kmsKey`: [IKeyRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_kms.IKeyRef.html) = the aws/fsx default KMS key for the AWS account being deployed into. — 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.

- `lustreConfiguration`: [LustreConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_fsx.LustreConfiguration.html) (required) — Additional configuration for FSx specific to Lustre.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.RETAIN — Policy to apply when the file system is removed from the stack.

- `securityGroup`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html) = creates new security group which allows all outbound traffic. — Security Group to assign to this file system.

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

- `storageCapacityGiB`: number (required) — 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.

- `storageType`: [StorageType](/cdk/api/v2/docs/aws-cdk-lib.aws_fsx.StorageType.html) = StorageType.SSD — The storage type for the file system that you're creating.

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) (required) — The VPC to launch the file system in.

- `vpcSubnet`: [ISubnet](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISubnet.html) (required) — The subnet that the file system will be accessible from.