Interface CfnFileSystem.LustreConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFileSystem.LustreConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnFileSystem
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.fsx.*; LustreConfigurationProperty lustreConfigurationProperty = LustreConfigurationProperty.builder() .autoImportPolicy("autoImportPolicy") .automaticBackupRetentionDays(123) .copyTagsToBackups(false) .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime") .dataCompressionType("dataCompressionType") .deploymentType("deploymentType") .driveCacheType("driveCacheType") .exportPath("exportPath") .importedFileChunkSize(123) .importPath("importPath") .metadataConfiguration(MetadataConfigurationProperty.builder() .iops(123) .mode("mode") .build()) .perUnitStorageThroughput(123) .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnFileSystem.LustreConfigurationProperty
static final class
An implementation forCfnFileSystem.LustreConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings.default Number
The number of days to retain automatic backups.default Object
(Optional) Not available for use with file systems that are linked to a data repository.default String
A recurring daily time, in the formatHH:MM
.default String
Sets the data compression configuration for the file system.default String
(Optional) ChooseSCRATCH_1
andSCRATCH_2
deployment types when you need temporary storage and shorter-term processing of data.default String
The type of drive cache used byPERSISTENT_1
file systems that are provisioned with HDD storage devices.default String
(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported.default Number
(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.default String
(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.default Object
default Number
Required withPERSISTENT_1
andPERSISTENT_2
deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB.default String
A recurring weekly time, in the formatD:HH:MM
.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAutoImportPolicy
(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.
AutoImportPolicy
can 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.
- See Also:
-
getAutomaticBackupRetentionDays
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. The default is0
.- See Also:
-
getCopyTagsToBackups
(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. If
CopyTagsToBackups
is 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. IfCopyTagsToBackups
is 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 .
- See Also:
-
getDailyAutomaticBackupStartTime
A recurring daily time, in the formatHH:MM
.HH
is the zero-padded hour of the day (0-23), andMM
is the zero-padded minute of the hour. For example,05:00
specifies 5 AM daily.- See Also:
-
getDataCompressionType
Sets the data compression configuration for the file system.DataCompressionType
can 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 .
- See Also:
-
getDeploymentType
(Optional) ChooseSCRATCH_1
andSCRATCH_2
deployment types when you need temporary storage and shorter-term processing of data.The
SCRATCH_2
deployment type provides in-transit encryption of data and higher burst throughput capacity thanSCRATCH_1
.Choose
PERSISTENT_1
for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive.PERSISTENT_1
supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available.Choose
PERSISTENT_2
for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput.PERSISTENT_2
supports SSD storage, and offers higherPerUnitStorageThroughput
(up to 1000 MB/s/TiB). You can optionally specify a metadata configuration mode forPERSISTENT_2
which supports increasing metadata performance.PERSISTENT_2
is available in a limited number of AWS Regions . For more information, and an up-to-date list of AWS Regions in whichPERSISTENT_2
is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide .If you choose
PERSISTENT_2
, and you setFileSystemTypeVersion
to2.10
, theCreateFileSystem
operation fails.Encryption of data in transit is automatically turned on when you access
SCRATCH_2
,PERSISTENT_1
, andPERSISTENT_2
file 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
)- See Also:
-
getDriveCacheType
The type of drive cache used byPERSISTENT_1
file systems that are provisioned with HDD storage devices.This parameter is required when storage type is HDD. Set this property to
READ
to 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
StorageType
is set toHDD
andDeploymentType
isPERSISTENT_1
.- See Also:
-
getExportPath
(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 an
ExportPath
value 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.
- See Also:
-
getImportedFileChunkSize
(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.
- See Also:
-
getImportPath
(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 is
s3://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.
- See Also:
-
getMetadataConfiguration
- See Also:
-
getPerUnitStorageThroughput
Required withPERSISTENT_1
andPERSISTENT_2
deployment 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 the
PerUnitStorageThroughput
(MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB ofPerUnitStorageThroughput
yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.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.
- See Also:
- For
-
getWeeklyMaintenanceStartTime
A recurring weekly time, in the formatD:HH:MM
.D
is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .HH
is the zero-padded hour of the day (0-23), andMM
is the zero-padded minute of the hour.For example,
1:05:00
specifies maintenance at 5 AM Monday.- See Also:
-
builder
-