2.170.0

interface LustreConfiguration

LanguageType name
.NETAmazon.CDK.AWS.FSx.LustreConfiguration
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsfsx#LustreConfiguration
Javasoftware.amazon.awscdk.services.fsx.LustreConfiguration
Pythonaws_cdk.aws_fsx.LustreConfiguration
TypeScript (source)aws-cdk-lib » aws_fsx » LustreConfiguration

The configuration for the Amazon FSx for Lustre file system.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html

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

NameTypeDescription
deploymentTypeLustreDeploymentTypeThe type of backing file system deployment used by FSx.
autoImportPolicy?LustreAutoImportPolicyAvailable with Scratch and Persistent_1 deployment types.
automaticBackupRetention?DurationThe number of days to retain automatic backups.
copyTagsToBackups?booleanA boolean flag indicating whether tags for the file system should be copied to backups.
dailyAutomaticBackupStartTime?DailyAutomaticBackupStartTimeStart time for 30-minute daily automatic backup window in Coordinated Universal Time (UTC).
dataCompressionType?LustreDataCompressionTypeSets the data compression configuration for the file system.
driveCacheType?DriveCacheTypeThe type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices.
exportPath?stringThe path in Amazon S3 where the root of your Amazon FSx file system is exported.
importPath?stringThe path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system.
importedFileChunkSizeMiB?numberFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk.
perUnitStorageThroughput?numberProvisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB.
weeklyMaintenanceStartTime?LustreMaintenanceTimeThe preferred day and time to perform weekly maintenance.

deploymentType

Type: LustreDeploymentType

The type of backing file system deployment used by FSx.

autoImportPolicy?

Type: LustreAutoImportPolicy (optional, default: no import policy)

Available with Scratch and Persistent_1 deployment types.

When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

For more information, see Automatically import updates from your S3 bucket .

This parameter is not supported for Lustre file systems using the Persistent_2 deployment type.

automaticBackupRetention?

Type: Duration (optional, default: Duration.days(0))

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

Automatic Backups is not supported on scratch file systems.

copyTagsToBackups?

Type: boolean (optional, default: false)

A boolean flag indicating whether tags for the file system should be copied to backups.

dailyAutomaticBackupStartTime?

Type: DailyAutomaticBackupStartTime (optional, default: no backup window)

Start time for 30-minute daily automatic backup window in Coordinated Universal Time (UTC).

dataCompressionType?

Type: LustreDataCompressionType (optional, default: no compression)

Sets the data compression configuration for the file system.

For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide .

driveCacheType?

Type: DriveCacheType (optional, default: no drive cache)

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices.

exportPath?

Type: string (optional, default: s3://import-bucket/FSxLustre[creation-timestamp])

The path in Amazon S3 where the root of your Amazon FSx file system is exported.

The path must use the same Amazon S3 bucket as specified in ImportPath. If you only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

importPath?

Type: string (optional, default: no bucket is imported)

The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system.

Must be of the format "s3://{bucketName}/optional-prefix" and cannot exceed 900 characters.

importedFileChunkSizeMiB?

Type: number (optional, default: 1024)

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk.

Allowed values are between 1 and 512,000.

perUnitStorageThroughput?

Type: number (optional, default: no default, conditionally required for PERSISTENT_1 and PERSISTENT_2 deployment type)

Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB.

Required with PERSISTENT_1 and PERSISTENT_2 deployment types.

Valid values:

  • For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.
  • For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.
  • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.

weeklyMaintenanceStartTime?

Type: LustreMaintenanceTime (optional, default: no preference)

The preferred day and time to perform weekly maintenance.

The first digit is the day of the week, starting at 1 for Monday, then the following are hours and minutes in the UTC time zone, 24 hour clock. For example: '2:20:30' is Tuesdays at 20:30.

← PreviousNext →