Interface CfnFileSystem.ILustreConfigurationProperty
The configuration for the Amazon FSx for Lustre file system.
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public interface ILustreConfigurationPropertySyntax (vb)
Public Interface ILustreConfigurationPropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FSx;
var lustreConfigurationProperty = new LustreConfigurationProperty {
AutoImportPolicy = "autoImportPolicy",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = false,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DataCompressionType = "dataCompressionType",
DeploymentType = "deploymentType",
DriveCacheType = "driveCacheType",
ExportPath = "exportPath",
ImportedFileChunkSize = 123,
ImportPath = "importPath",
PerUnitStorageThroughput = 123,
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
};Synopsis
Properties
| AutoImportPolicy | (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. |
| AutomaticBackupRetentionDays | The number of days to retain automatic backups. |
| CopyTagsToBackups | A Boolean flag indicating whether tags for the file system should be copied to backups. |
| DailyAutomaticBackupStartTime | A recurring daily time, in the format |
| DataCompressionType | Sets the data compression configuration for the file system. |
| DeploymentType | (Optional) Choose |
| DriveCacheType | The type of drive cache used by |
| ExportPath | (Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. |
| 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. |
| 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. |
| PerUnitStorageThroughput | Required with |
| WeeklyMaintenanceStartTime | A recurring weekly time, in the format |
Properties
AutoImportPolicy
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings.
virtual string AutoImportPolicy { get; }Property Value
System.String
Remarks
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 with a data repository association.
AutomaticBackupRetentionDays
The number of days to retain automatic backups.
virtual Nullable<double> AutomaticBackupRetentionDays { get; }Property Value
System.Nullable<System.Double>
Remarks
Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0 .
CopyTagsToBackups
A Boolean flag indicating whether tags for the file system should be copied to backups.
virtual object CopyTagsToBackups { get; }Property Value
System.Object
Remarks
This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more 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. Only valid for use with PERSISTENT_1 deployment types.
DailyAutomaticBackupStartTime
A recurring daily time, in the format HH:MM .
virtual string DailyAutomaticBackupStartTime { get; }Property Value
System.String
Remarks
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DataCompressionType
Sets the data compression configuration for the file system. DataCompressionType can have the following values:.
virtual string DataCompressionType { get; }Property Value
System.String
Remarks
For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide .
DeploymentType
(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data.
virtual string DeploymentType { get; }Property Value
System.String
Remarks
The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_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 higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 is available in a limited number of AWS Regions . For more information, and an up-to-date list of AWS Regions in which PERSISTENT_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 set FileSystemTypeVersion to 2.10 , the CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access SCRATCH_2 , PERSISTENT_1 and PERSISTENT_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 )
DriveCacheType
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices.
virtual string DriveCacheType { get; }Property Value
System.String
Remarks
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 to HDD and DeploymentType is PERSISTENT_1 .
ExportPath
(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported.
virtual string ExportPath { get; }Property Value
System.String
Remarks
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 example s3://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 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.
This parameter is not supported for file systems with a data repository association.
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.
virtual Nullable<double> ImportedFileChunkSize { get; }Property Value
System.Nullable<System.Double>
Remarks
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.
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.
virtual string ImportPath { get; }Property Value
System.String
Remarks
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.
PerUnitStorageThroughput
Required with PERSISTENT_1 and PERSISTENT_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.
virtual Nullable<double> PerUnitStorageThroughput { get; }Property Value
System.Nullable<System.Double>
Remarks
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 of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values:
WeeklyMaintenanceStartTime
A recurring weekly time, in the format D:HH:MM .
virtual string WeeklyMaintenanceStartTime { get; }Property Value
System.String
Remarks
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), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.