interface LustreFileSystemProps

Language	Type name
.NET	`Amazon.CDK.AWS.FSx.LustreFileSystemProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsfsx#LustreFileSystemProps`
Java	`software.amazon.awscdk.services.fsx.LustreFileSystemProps`
Python	`aws_cdk.aws_fsx.LustreFileSystemProps`
TypeScript (source)	`aws-cdk-lib` » `aws_fsx` » `LustreFileSystemProps`

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

Example

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

Name	Type	Description
lustreConfiguration	`LustreConfiguration`	Additional configuration for FSx specific to Lustre.
storageCapacityGiB	`number`	The storage capacity of the file system being created.
vpc	`IVpc`	The VPC to launch the file system in.
vpcSubnet	`ISubnet`	The subnet that the file system will be accessible from.
backupId?	`string`	The ID of the backup.
fileSystemTypeVersion?	`FileSystemTypeVersion`	The Lustre version for the file system.
kmsKey?	`IKey`	The KMS key used for encryption to protect your data at rest.
removalPolicy?	`RemovalPolicy`	Policy to apply when the file system is removed from the stack.
securityGroup?	`ISecurityGroup`	Security Group to assign to this file system.
storageType?	`StorageType`	The storage type for the file system that you're creating.

lustreConfiguration

Type: LustreConfiguration

Additional configuration for FSx specific to Lustre.

storageCapacityGiB

Type: 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.

vpc

Type: IVpc

The VPC to launch the file system in.

vpcSubnet

Type: ISubnet

The subnet that the file system will be accessible from.

backupId?

Type: string (optional, default: 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?

Type: FileSystemTypeVersion (optional, 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.)

The Lustre version for the file system.

kmsKey?

Type: IKey (optional, default: 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.

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

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

securityGroup?

Type: ISecurityGroup (optional, default: creates new security group which allows all outbound traffic.)

Security Group to assign to this file system.

storageType?

Type: StorageType (optional, default: StorageType.SSD)

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