Class LustreConfiguration.Builder
java.lang.Object
software.amazon.awscdk.services.fsx.LustreConfiguration.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<LustreConfiguration>
- Enclosing interface:
LustreConfiguration
@Stability(Stable)
public static final class LustreConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<LustreConfiguration>
A builder for
LustreConfiguration
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionautoImportPolicy
(LustreAutoImportPolicy autoImportPolicy) Sets the value ofLustreConfiguration.getAutoImportPolicy()
automaticBackupRetention
(Duration automaticBackupRetention) Sets the value ofLustreConfiguration.getAutomaticBackupRetention()
build()
Builds the configured instance.copyTagsToBackups
(Boolean copyTagsToBackups) Sets the value ofLustreConfiguration.getCopyTagsToBackups()
dailyAutomaticBackupStartTime
(DailyAutomaticBackupStartTime dailyAutomaticBackupStartTime) Sets the value ofLustreConfiguration.getDailyAutomaticBackupStartTime()
dataCompressionType
(LustreDataCompressionType dataCompressionType) Sets the value ofLustreConfiguration.getDataCompressionType()
deploymentType
(LustreDeploymentType deploymentType) Sets the value ofLustreConfiguration.getDeploymentType()
exportPath
(String exportPath) Sets the value ofLustreConfiguration.getExportPath()
importedFileChunkSizeMiB
(Number importedFileChunkSizeMiB) Sets the value ofLustreConfiguration.getImportedFileChunkSizeMiB()
importPath
(String importPath) Sets the value ofLustreConfiguration.getImportPath()
perUnitStorageThroughput
(Number perUnitStorageThroughput) Sets the value ofLustreConfiguration.getPerUnitStorageThroughput()
weeklyMaintenanceStartTime
(LustreMaintenanceTime weeklyMaintenanceStartTime) Sets the value ofLustreConfiguration.getWeeklyMaintenanceStartTime()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
deploymentType
@Stability(Stable) public LustreConfiguration.Builder deploymentType(LustreDeploymentType deploymentType) Sets the value ofLustreConfiguration.getDeploymentType()
- Parameters:
deploymentType
- The type of backing file system deployment used by FSx. This parameter is required.- Returns:
this
-
autoImportPolicy
@Stability(Stable) public LustreConfiguration.Builder autoImportPolicy(LustreAutoImportPolicy autoImportPolicy) Sets the value ofLustreConfiguration.getAutoImportPolicy()
- Parameters:
autoImportPolicy
- Available withScratch
andPersistent_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.- Returns:
this
-
automaticBackupRetention
@Stability(Stable) public LustreConfiguration.Builder automaticBackupRetention(Duration automaticBackupRetention) Sets the value ofLustreConfiguration.getAutomaticBackupRetention()
- Parameters:
automaticBackupRetention
- 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.
- Returns:
this
-
copyTagsToBackups
Sets the value ofLustreConfiguration.getCopyTagsToBackups()
- Parameters:
copyTagsToBackups
- A boolean flag indicating whether tags for the file system should be copied to backups.- Returns:
this
-
dailyAutomaticBackupStartTime
@Stability(Stable) public LustreConfiguration.Builder dailyAutomaticBackupStartTime(DailyAutomaticBackupStartTime dailyAutomaticBackupStartTime) Sets the value ofLustreConfiguration.getDailyAutomaticBackupStartTime()
- Parameters:
dailyAutomaticBackupStartTime
- Start time for 30-minute daily automatic backup window in Coordinated Universal Time (UTC).- Returns:
this
-
dataCompressionType
@Stability(Stable) public LustreConfiguration.Builder dataCompressionType(LustreDataCompressionType dataCompressionType) Sets the value ofLustreConfiguration.getDataCompressionType()
- Parameters:
dataCompressionType
- Sets the data compression configuration for the file system. For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide .- Returns:
this
-
exportPath
Sets the value ofLustreConfiguration.getExportPath()
- Parameters:
exportPath
- 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.- Returns:
this
-
importedFileChunkSizeMiB
@Stability(Stable) public LustreConfiguration.Builder importedFileChunkSizeMiB(Number importedFileChunkSizeMiB) Sets the value ofLustreConfiguration.getImportedFileChunkSizeMiB()
- Parameters:
importedFileChunkSizeMiB
- 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.- Returns:
this
-
importPath
Sets the value ofLustreConfiguration.getImportPath()
- Parameters:
importPath
- 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.- Returns:
this
-
perUnitStorageThroughput
@Stability(Stable) public LustreConfiguration.Builder perUnitStorageThroughput(Number perUnitStorageThroughput) Sets the value ofLustreConfiguration.getPerUnitStorageThroughput()
- Parameters:
perUnitStorageThroughput
- 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.- Returns:
this
-
weeklyMaintenanceStartTime
@Stability(Stable) public LustreConfiguration.Builder weeklyMaintenanceStartTime(LustreMaintenanceTime weeklyMaintenanceStartTime) Sets the value ofLustreConfiguration.getWeeklyMaintenanceStartTime()
- Parameters:
weeklyMaintenanceStartTime
- 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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<LustreConfiguration>
- Returns:
- a new instance of
LustreConfiguration
- Throws:
NullPointerException
- if any required attribute was not provided
-