class Aws::FSx::Types::CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created.

@note When making an API call, you may pass CreateFileSystemLustreConfiguration

data as a hash:

    {
      weekly_maintenance_start_time: "WeeklyTime",
      import_path: "ArchivePath",
      export_path: "ArchivePath",
      imported_file_chunk_size: 1,
      deployment_type: "SCRATCH_1", # accepts SCRATCH_1, SCRATCH_2, PERSISTENT_1
      auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED
      per_unit_storage_throughput: 1,
      daily_automatic_backup_start_time: "DailyTime",
      automatic_backup_retention_days: 1,
      copy_tags_to_backups: false,
      drive_cache_type: "NONE", # accepts NONE, READ
      data_compression_type: "NONE", # accepts NONE, LZ4
    }

@!attribute [rw] weekly_maintenance_start_time

(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.
@return [String]

@!attribute [rw] import_path

(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.
@return [String]

@!attribute [rw] export_path

(Optional) 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. 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 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.
@return [String]

@!attribute [rw] imported_file_chunk_size

(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.
@return [Integer]

@!attribute [rw] deployment_type

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` deployment type for longer-term storage and
workloads and encryption of data in transit. To learn more about
deployment types, see [ FSx for Lustre Deployment Options][1].

Encryption of data in-transit is automatically enabled when you
access a `SCRATCH_2` or `PERSISTENT_1` file system from Amazon EC2
instances that [support this feature][2]. (Default = `SCRATCH_1`)

Encryption of data in-transit for `SCRATCH_2` and `PERSISTENT_1`
deployment types is supported when accessed from supported instance
types in supported Amazon Web Services Regions. To learn more,
[Encrypting Data in Transit][3].

[1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html
[2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html
[3]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html
@return [String]

@!attribute [rw] auto_import_policy

(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.

For more information, see [Automatically import updates from your S3
bucket][1].

[1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html
@return [String]

@!attribute [rw] per_unit_storage_throughput

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. 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 SSD storage: 50, 100, 200. Valid values for HDD
storage: 12, 40.
@return [Integer]

@!attribute [rw] daily_automatic_backup_start_time

A recurring daily time, in the format `HH:MM`. `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.
@return [String]

@!attribute [rw] automatic_backup_retention_days

The number of days to retain automatic backups. Setting this to 0
disables automatic backups. You can retain automatic backups for a
maximum of 90 days. The default is 0.
@return [Integer]

@!attribute [rw] copy_tags_to_backups

(Optional) Not available to 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 it's 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 this value is 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.

For more information, see [Working with backups][1].

[1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html
@return [Boolean]

@!attribute [rw] drive_cache_type

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 to `READ`, improve the performance for
frequently accessed files and allows 20% of the total storage
capacity of the file system to be cached.

This parameter is required when `StorageType` is set to HDD.
@return [String]

@!attribute [rw] data_compression_type

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][1].

[1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemLustreConfiguration AWS API Documentation

Constants

SENSITIVE