Package software.amazon.awscdk.services.fsx

Interface LustreConfiguration

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
LustreConfiguration.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:30.398Z") @Stability(Stable) public interface LustreConfiguration extends software.amazon.jsii.JsiiSerializable
The configuration for the Amazon FSx for Lustre file system.

Example: 

 import software.amazon.awscdk.services.s3.*;
 Vpc vpc;
 Bucket bucket;
 Map<String, Object> lustreConfiguration = Map.of(
         "deploymentType", LustreDeploymentType.SCRATCH_2,
         "exportPath", bucket.s3UrlForObject(),
         "importPath", bucket.s3UrlForObject(),
         "autoImportPolicy", LustreAutoImportPolicy.NEW_CHANGED_DELETED);
 LustreFileSystem fs = LustreFileSystem.Builder.create(this, "FsxLustreFileSystem")
         .vpc(vpc)
         .vpcSubnet(vpc.getPrivateSubnets()[0])
         .storageCapacityGiB(1200)
         .lustreConfiguration(lustreConfiguration)
         .build();

See Also:

  • Method Details

    • getDeploymentType

      @Stability(Stable) @NotNull LustreDeploymentType getDeploymentType()
      The type of backing file system deployment used by FSx.

    • getAutoImportPolicy

      @Stability(Stable) @Nullable default LustreAutoImportPolicy getAutoImportPolicy()
      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.

      Default: - no import policy

    • getDataCompressionType

      @Stability(Stable) @Nullable default LustreDataCompressionType getDataCompressionType()
      Sets the data compression configuration for the file system.

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

      Default: - no compression

    • getExportPath

      @Stability(Stable) @Nullable default String getExportPath()
      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.

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

    • getImportedFileChunkSizeMiB

      @Stability(Stable) @Nullable default Number getImportedFileChunkSizeMiB()
      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.

      Default: 1024

    • getImportPath

      @Stability(Stable) @Nullable default String getImportPath()
      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.

      Default: - no bucket is imported

    • getPerUnitStorageThroughput

      @Stability(Stable) @Nullable default Number getPerUnitStorageThroughput()
      Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB.

      Valid values are 50, 100, 200.

      Default: - no default, conditionally required for PERSISTENT_1 deployment type

    • getWeeklyMaintenanceStartTime

      @Stability(Stable) @Nullable default LustreMaintenanceTime getWeeklyMaintenanceStartTime()
      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.

      Default: - no preference

    • builder

      @Stability(Stable) static LustreConfiguration.Builder builder()
      Returns:
      a LustreConfiguration.Builder of LustreConfiguration