AWS CDK Reference

Appearance

v2.274.0

LustreFileSystemProps Struct ​

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

Source
aws-fsx/lib/lustre-file-system.ts
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 ​

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

fileSystemTypeVersionFileSystemTypeVersionfile_system_type_versionFileSystemTypeVersionfileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersion= V_2_10, except for PERSISTENT_2 …#
The Lustre version for the file system.
default

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.

kmsKeyIKeyRefkms_keyIKeyRefkmsKeyIKeyRefKmsKeyIKeyRefKmsKeyIKeyRef= the aws/fsx default KMS key for …#
The KMS key used for encryption to protect your data at rest.
default

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

lustreConfigurationLustreConfigurationlustre_configurationLustreConfigurationlustreConfigurationLustreConfigurationLustreConfigurationLustreConfigurationLustreConfigurationLustreConfigurationrequired#
Additional configuration for FSx specific to Lustre.
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.RETAIN#
Policy to apply when the file system is removed from the stack.
securityGroupISecurityGroupsecurity_groupISecurityGroupsecurityGroupISecurityGroupSecurityGroupISecurityGroupSecurityGroupISecurityGroup= creates new security group which…#
Security Group to assign to this file system.
default

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

storageCapacityGiBnumberstorage_capacity_gi_bint | floatstorageCapacityGiBNumberStorageCapacityGiBdoubleStorageCapacityGiB*float64required#
The storage capacity of the file system being created.
notes

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.

storageTypeStorageTypestorage_typeStorageTypestorageTypeStorageTypeStorageTypeStorageTypeStorageTypeStorageType= StorageType.SSD#
The storage type for the file system that you're creating.
vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpcrequired#
The VPC to launch the file system in.
vpcSubnetISubnetvpc_subnetISubnetvpcSubnetISubnetVpcSubnetISubnetVpcSubnetISubnetrequired#
The subnet that the file system will be accessible from.