1.204.0

interface LustreFileSystemProps

LanguageType name
.NETAmazon.CDK.AWS.FSx.LustreFileSystemProps
Javasoftware.amazon.awscdk.services.fsx.LustreFileSystemProps
Pythonaws_cdk.aws_fsx.LustreFileSystemProps
TypeScript (source)@aws-cdk/aws-fsx » LustreFileSystemProps

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

Example

declare const vpc: ec2.Vpc;

const fileSystem = new fsx.LustreFileSystem(this, 'FsxLustreFileSystem', {
  lustreConfiguration: { deploymentType: fsx.LustreDeploymentType.SCRATCH_2 },
  storageCapacityGiB: 1200,
  vpc,
  vpcSubnet: vpc.privateSubnets[0],
});

Properties

NameTypeDescription
lustreConfigurationLustreConfigurationAdditional configuration for FSx specific to Lustre.
storageCapacityGiBnumberThe storage capacity of the file system being created.
vpcIVpcThe VPC to launch the file system in.
vpcSubnetISubnetThe subnet that the file system will be accessible from.
backupId?stringThe ID of the backup.
kmsKey?IKeyThe KMS key used for encryption to protect your data at rest.
removalPolicy?RemovalPolicyPolicy to apply when the file system is removed from the stack.
securityGroup?ISecurityGroupSecurity Group to assign to this file system.

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 and PERSISTENT_1 types, valid values are 1,200, 2,400, then continuing in increments of 2,400 GiB.

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.

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.

← PreviousNext →