Class CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFileSystemPropsMixin.LustreConfigurationProperty>
- Enclosing interface:
CfnFileSystemPropsMixin.LustreConfigurationProperty
CfnFileSystemPropsMixin.LustreConfigurationProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionautoImportPolicy(String autoImportPolicy) automaticBackupRetentionDays(Number automaticBackupRetentionDays) build()Builds the configured instance.copyTagsToBackups(Boolean copyTagsToBackups) copyTagsToBackups(IResolvable copyTagsToBackups) dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime) dataCompressionType(String dataCompressionType) dataReadCacheConfiguration(CfnFileSystemPropsMixin.DataReadCacheConfigurationProperty dataReadCacheConfiguration) dataReadCacheConfiguration(IResolvable dataReadCacheConfiguration) deploymentType(String deploymentType) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getDeploymentType()driveCacheType(String driveCacheType) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getDriveCacheType()efaEnabled(Boolean efaEnabled) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getEfaEnabled()efaEnabled(IResolvable efaEnabled) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getEfaEnabled()exportPath(String exportPath) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getExportPath()importedFileChunkSize(Number importedFileChunkSize) importPath(String importPath) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getImportPath()metadataConfiguration(CfnFileSystemPropsMixin.MetadataConfigurationProperty metadataConfiguration) metadataConfiguration(IResolvable metadataConfiguration) perUnitStorageThroughput(Number perUnitStorageThroughput) throughputCapacity(Number throughputCapacity) weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
autoImportPolicy
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder autoImportPolicy(String autoImportPolicy) - Parameters:
autoImportPolicy- (Optional) 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.AutoImportPolicycan have the following values:NONE- (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.NEW- AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.NEW_CHANGED- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.NEW_CHANGED_DELETED- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
For more information, see Automatically import updates from your S3 bucket .
This parameter is not supported for Lustre file systems with a data repository association.
- Returns:
this
-
automaticBackupRetentionDays
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder automaticBackupRetentionDays(Number automaticBackupRetentionDays) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getAutomaticBackupRetentionDays()- Parameters:
automaticBackupRetentionDays- The number of days to retain automatic backups. Setting this property to0disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is0.- Returns:
this
-
copyTagsToBackups
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder copyTagsToBackups(Boolean copyTagsToBackups) - Parameters:
copyTagsToBackups- (Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. IfCopyTagsToBackupsis set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. IfCopyTagsToBackupsis set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.(Default =
false)For more information, see Working with backups in the Amazon FSx for Lustre User Guide .
- Returns:
this
-
copyTagsToBackups
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder copyTagsToBackups(IResolvable copyTagsToBackups) - Parameters:
copyTagsToBackups- (Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. IfCopyTagsToBackupsis set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. IfCopyTagsToBackupsis set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.(Default =
false)For more information, see Working with backups in the Amazon FSx for Lustre User Guide .
- Returns:
this
-
dailyAutomaticBackupStartTime
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getDailyAutomaticBackupStartTime()- Parameters:
dailyAutomaticBackupStartTime- A recurring daily time, in the formatHH:MM.HHis the zero-padded hour of the day (0-23), andMMis the zero-padded minute of the hour. For example,05:00specifies 5 AM daily.- Returns:
this
-
dataCompressionType
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder dataCompressionType(String dataCompressionType) - Parameters:
dataCompressionType- Sets the data compression configuration for the file system.DataCompressionTypecan have the following values:.NONE- (Default) Data compression is turned off when the file system is created.LZ4- Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide .
- Returns:
this
-
dataReadCacheConfiguration
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder dataReadCacheConfiguration(IResolvable dataReadCacheConfiguration) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getDataReadCacheConfiguration()- Parameters:
dataReadCacheConfiguration- Specifies the optional provisioned SSD read cache on FSx for Lustre file systems that use the Intelligent-Tiering storage class. Required whenStorageTypeis set toINTELLIGENT_TIERING.- Returns:
this
-
dataReadCacheConfiguration
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder dataReadCacheConfiguration(CfnFileSystemPropsMixin.DataReadCacheConfigurationProperty dataReadCacheConfiguration) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getDataReadCacheConfiguration()- Parameters:
dataReadCacheConfiguration- Specifies the optional provisioned SSD read cache on FSx for Lustre file systems that use the Intelligent-Tiering storage class. Required whenStorageTypeis set toINTELLIGENT_TIERING.- Returns:
this
-
deploymentType
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder deploymentType(String deploymentType) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getDeploymentType()- Parameters:
deploymentType- (Optional) ChooseSCRATCH_1andSCRATCH_2deployment types when you need temporary storage and shorter-term processing of data. TheSCRATCH_2deployment type provides in-transit encryption of data and higher burst throughput capacity thanSCRATCH_1.Choose
PERSISTENT_1for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive.PERSISTENT_1supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available.Choose
PERSISTENT_2for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput.PERSISTENT_2supports the SSD and Intelligent-Tiering storage classes. You can optionally specify a metadata configuration mode forPERSISTENT_2which supports increasing metadata performance.PERSISTENT_2is available in a limited number of AWS Regions . For more information, and an up-to-date list of AWS Regions in whichPERSISTENT_2is available, see Deployment and storage class options for FSx for Lustre file systems in the Amazon FSx for Lustre User Guide .If you choose
PERSISTENT_2, and you setFileSystemTypeVersionto2.10, theCreateFileSystemoperation fails.Encryption of data in transit is automatically turned on when you access
SCRATCH_2,PERSISTENT_1, andPERSISTENT_2file systems from Amazon EC2 instances that support automatic encryption in the AWS Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide .(Default =
SCRATCH_1)- Returns:
this
-
driveCacheType
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder driveCacheType(String driveCacheType) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getDriveCacheType()- Parameters:
driveCacheType- The type of drive cache used byPERSISTENT_1file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property toREADto improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.This parameter is required when
StorageTypeis set toHDDandDeploymentTypeisPERSISTENT_1.- Returns:
this
-
efaEnabled
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder efaEnabled(Boolean efaEnabled) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getEfaEnabled()- Parameters:
efaEnabled- (Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. (Default =false)- Returns:
this
-
efaEnabled
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder efaEnabled(IResolvable efaEnabled) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getEfaEnabled()- Parameters:
efaEnabled- (Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. (Default =false)- Returns:
this
-
exportPath
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder exportPath(String exportPath) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getExportPath()- Parameters:
exportPath- (Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If anExportPathvalue is not provided, Amazon FSx sets a default export path,s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for examples3://import-bucket/FSxLustre20181105T222312Z.The Amazon S3 export bucket must be the same as the import bucket specified by
ImportPath. If you specify only a bucket name, such ass3://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 ass3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.This parameter is not supported for file systems with a data repository association.
- Returns:
this
-
importedFileChunkSize
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder importedFileChunkSize(Number importedFileChunkSize) - Parameters:
importedFileChunkSize- (Optional) 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. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
This parameter is not supported for Lustre file systems with a data repository association.
- Returns:
this
-
importPath
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder importPath(String importPath) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getImportPath()- Parameters:
importPath- (Optional) 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. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example iss3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.This parameter is not supported for Lustre file systems with a data repository association.
- Returns:
this
-
metadataConfiguration
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder metadataConfiguration(IResolvable metadataConfiguration) - Parameters:
metadataConfiguration- The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using aPERSISTENT_2deployment type.- Returns:
this
-
metadataConfiguration
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder metadataConfiguration(CfnFileSystemPropsMixin.MetadataConfigurationProperty metadataConfiguration) - Parameters:
metadataConfiguration- The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using aPERSISTENT_2deployment type.- Returns:
this
-
perUnitStorageThroughput
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder perUnitStorageThroughput(Number perUnitStorageThroughput) - Parameters:
perUnitStorageThroughput- Required withPERSISTENT_1andPERSISTENT_2deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by thePerUnitStorageThroughput(MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB ofPerUnitStorageThroughputyields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.Valid values:
- For
PERSISTENT_1SSD storage: 50, 100, 200 MB/s/TiB. - For
PERSISTENT_1HDD storage: 12, 40 MB/s/TiB. - For
PERSISTENT_2SSD storage: 125, 250, 500, 1000 MB/s/TiB.
- For
- Returns:
this
-
throughputCapacity
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder throughputCapacity(Number throughputCapacity) - Parameters:
throughputCapacity- Specifies the throughput of an FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). Valid values are 4000 MBps or multiples of 4000 MBps. You pay for the amount of throughput that you provision.- Returns:
this
-
weeklyMaintenanceStartTime
@Stability(Stable) public CfnFileSystemPropsMixin.LustreConfigurationProperty.Builder weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime) Sets the value ofCfnFileSystemPropsMixin.LustreConfigurationProperty.getWeeklyMaintenanceStartTime()- Parameters:
weeklyMaintenanceStartTime- The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example,1:05:00specifies maintenance at 5 AM Monday.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnFileSystemPropsMixin.LustreConfigurationProperty>- Returns:
- a new instance of
CfnFileSystemPropsMixin.LustreConfigurationProperty - Throws:
NullPointerException- if any required attribute was not provided
-