Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data CreateFileSystemLustreConfiguration = CreateFileSystemLustreConfiguration' {
- autoImportPolicy :: Maybe AutoImportPolicyType
- automaticBackupRetentionDays :: Maybe Natural
- copyTagsToBackups :: Maybe Bool
- dailyAutomaticBackupStartTime :: Maybe Text
- dataCompressionType :: Maybe DataCompressionType
- deploymentType :: Maybe LustreDeploymentType
- driveCacheType :: Maybe DriveCacheType
- exportPath :: Maybe Text
- importPath :: Maybe Text
- importedFileChunkSize :: Maybe Natural
- logConfiguration :: Maybe LustreLogCreateConfiguration
- perUnitStorageThroughput :: Maybe Natural
- rootSquashConfiguration :: Maybe LustreRootSquashConfiguration
- weeklyMaintenanceStartTime :: Maybe Text
- newCreateFileSystemLustreConfiguration :: CreateFileSystemLustreConfiguration
- createFileSystemLustreConfiguration_autoImportPolicy :: Lens' CreateFileSystemLustreConfiguration (Maybe AutoImportPolicyType)
- createFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural)
- createFileSystemLustreConfiguration_copyTagsToBackups :: Lens' CreateFileSystemLustreConfiguration (Maybe Bool)
- createFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
- createFileSystemLustreConfiguration_dataCompressionType :: Lens' CreateFileSystemLustreConfiguration (Maybe DataCompressionType)
- createFileSystemLustreConfiguration_deploymentType :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreDeploymentType)
- createFileSystemLustreConfiguration_driveCacheType :: Lens' CreateFileSystemLustreConfiguration (Maybe DriveCacheType)
- createFileSystemLustreConfiguration_exportPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
- createFileSystemLustreConfiguration_importPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
- createFileSystemLustreConfiguration_importedFileChunkSize :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural)
- createFileSystemLustreConfiguration_logConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration)
- createFileSystemLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural)
- createFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration)
- createFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
Documentation
data CreateFileSystemLustreConfiguration Source #
The Lustre configuration for the file system being created.
The following parameters are not supported for file systems with the
Persistent_2
deployment type. Instead, use
CreateDataRepositoryAssociation
to create a data repository
association to link your Lustre file system to a data repository.
AutoImportPolicy
ExportPath
ImportedChunkSize
ImportPath
See: newCreateFileSystemLustreConfiguration
smart constructor.
CreateFileSystemLustreConfiguration' | |
|
Instances
newCreateFileSystemLustreConfiguration :: CreateFileSystemLustreConfiguration Source #
Create a value of CreateFileSystemLustreConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoImportPolicy:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_autoImportPolicy
- (Optional) 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:
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 file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
$sel:automaticBackupRetentionDays:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_automaticBackupRetentionDays
- Undocumented member.
$sel:copyTagsToBackups:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_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. 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. If CopyTagsToBackups
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.
$sel:dailyAutomaticBackupStartTime:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_dailyAutomaticBackupStartTime
- Undocumented member.
$sel:dataCompressionType:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_dataCompressionType
- 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.
$sel:deploymentType:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_deploymentType
- (Optional) Choose SCRATCH_1
and SCRATCH_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 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 Amazon Web
Services 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 Amazon Web Services Regions. For more
information, and an up-to-date list of Amazon Web Services 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 Amazon Web Services 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
)
$sel:driveCacheType:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_driveCacheType
- The type of drive cache used by PERSISTENT_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 to HDD
.
$sel:exportPath:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_exportPath
- (Optional) Available with Scratch
and Persistent_1
deployment types.
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 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 the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
$sel:importPath:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_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 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 file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
$sel:importedFileChunkSize:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_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 file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
$sel:logConfiguration:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_logConfiguration
- The Lustre logging configuration used when creating an Amazon FSx for
Lustre file system. When logging is enabled, Lustre logs error and
warning events for data repositories associated with your file system to
Amazon CloudWatch Logs.
$sel:perUnitStorageThroughput:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_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. 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:
- 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.
$sel:rootSquashConfiguration:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_rootSquashConfiguration
- The Lustre root squash configuration used when creating an Amazon FSx
for Lustre file system. When enabled, root squash restricts root-level
access from clients that try to access your file system as a root user.
$sel:weeklyMaintenanceStartTime:CreateFileSystemLustreConfiguration'
, createFileSystemLustreConfiguration_weeklyMaintenanceStartTime
- (Optional) 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.
createFileSystemLustreConfiguration_autoImportPolicy :: Lens' CreateFileSystemLustreConfiguration (Maybe AutoImportPolicyType) Source #
(Optional) 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:
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 file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #
Undocumented member.
createFileSystemLustreConfiguration_copyTagsToBackups :: Lens' CreateFileSystemLustreConfiguration (Maybe Bool) Source #
(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. If CopyTagsToBackups
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.
createFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
Undocumented member.
createFileSystemLustreConfiguration_dataCompressionType :: Lens' CreateFileSystemLustreConfiguration (Maybe DataCompressionType) Source #
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.
createFileSystemLustreConfiguration_deploymentType :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreDeploymentType) Source #
(Optional) Choose SCRATCH_1
and SCRATCH_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 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 Amazon Web
Services 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 Amazon Web Services Regions. For more
information, and an up-to-date list of Amazon Web Services 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 Amazon Web Services 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
)
createFileSystemLustreConfiguration_driveCacheType :: Lens' CreateFileSystemLustreConfiguration (Maybe DriveCacheType) Source #
The type of drive cache used by PERSISTENT_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 to HDD
.
createFileSystemLustreConfiguration_exportPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
(Optional) Available with Scratch
and Persistent_1
deployment types.
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 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 the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_importPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
(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 file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_importedFileChunkSize :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #
(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 file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_logConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration) Source #
The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.
createFileSystemLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #
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. 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:
- 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.
createFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration) Source #
The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
createFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
(Optional) 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.