aws-cdk-lib.aws_fsx.LustreConfiguration

LustreConfiguration Struct

The configuration for the Amazon FSx for Lustre file system.

Source

aws-fsx/lib/lustre-file-system.ts

Type last changed

v2.163.0 · 22 Oct 2024

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

autoImportPolicy?optionalLustreAutoImportPolicyauto_import_policy?optionalLustreAutoImportPolicyautoImportPolicy?optionalLustreAutoImportPolicyAutoImportPolicy?optionalLustreAutoImportPolicyAutoImportPolicy?optionalLustreAutoImportPolicy#

Available with `Scratch` and `Persistent_1` deployment types.

Default: no import policy

notes

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?optionalDurationautomatic_backup_retention?optionalDurationautomaticBackupRetention?optionalDurationAutomaticBackupRetention?optionalDurationAutomaticBackupRetention?optionalDuration= 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?optionalbooleancopy_tags_to_backups?optionalboolcopyTagsToBackups?optionalBooleanCopyTagsToBackups?optionalboolCopyTagsToBackups?optional*bool= false#

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

dailyAutomaticBackupStartTime?optionalDailyAutomaticBackupStartTimedaily_automatic_backup_start_time?optionalDailyAutomaticBackupStartTimedailyAutomaticBackupStartTime?optionalDailyAutomaticBackupStartTimeDailyAutomaticBackupStartTime?optionalDailyAutomaticBackupStartTimeDailyAutomaticBackupStartTime?optionalDailyAutomaticBackupStartTime#

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

Default: no backup window

dataCompressionType?optionalLustreDataCompressionTypedata_compression_type?optionalLustreDataCompressionTypedataCompressionType?optionalLustreDataCompressionTypeDataCompressionType?optionalLustreDataCompressionTypeDataCompressionType?optionalLustreDataCompressionType#

Sets the data compression configuration for the file system.

Default: no compression

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

deploymentTypeLustreDeploymentTypedeployment_typeLustreDeploymentTypedeploymentTypeLustreDeploymentTypeDeploymentTypeLustreDeploymentTypeDeploymentTypeLustreDeploymentTyperequired#

The type of backing file system deployment used by FSx.

driveCacheType?optionalDriveCacheTypedrive_cache_type?optionalDriveCacheTypedriveCacheType?optionalDriveCacheTypeDriveCacheType?optionalDriveCacheTypeDriveCacheType?optionalDriveCacheType#

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

Default: no drive cache

exportPath?optionalstringexport_path?optionalstrexportPath?optionalStringExportPath?optionalstringExportPath?optional*string#

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

Default: s3://import-bucket/FSxLustre[creation-timestamp]

notes

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.

importedFileChunkSizeMiB?optionalnumberimported_file_chunk_size_mi_b?optionalint | floatimportedFileChunkSizeMiB?optionalNumberImportedFileChunkSizeMiB?optionaldoubleImportedFileChunkSizeMiB?optional*float64= 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.

importPath?optionalstringimport_path?optionalstrimportPath?optionalStringImportPath?optionalstringImportPath?optional*string#

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.

Default: no bucket is imported

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

perUnitStorageThroughput?optionalnumberper_unit_storage_throughput?optionalint | floatperUnitStorageThroughput?optionalNumberPerUnitStorageThroughput?optionaldoublePerUnitStorageThroughput?optional*float64#

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

Default: no default, conditionally required for PERSISTENT_1 and PERSISTENT_2 deployment type

notes

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?optionalLustreMaintenanceTimeweekly_maintenance_start_time?optionalLustreMaintenanceTimeweeklyMaintenanceStartTime?optionalLustreMaintenanceTimeWeeklyMaintenanceStartTime?optionalLustreMaintenanceTimeWeeklyMaintenanceStartTime?optionalLustreMaintenanceTime#

The preferred day and time to perform weekly maintenance.

Default: no preference

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.