Class: Aws::FSx::Types::CreateFileSystemLustreConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

The Lustre configuration for the file system being created.

<note markdown=“1”> The following parameters are not supported for file systems with a data repository association created with .

* `AutoImportPolicy`

  • ‘ExportPath`

  • ‘ImportedFileChunkSize`

  • ‘ImportPath`

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_import_policy ⇒ String

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this parameter 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].

<note markdown=“1”> This parameter is not supported for file systems with a data repository association.

</note>

[1]: docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_backup_retention_days ⇒ Integer

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 is `0`.

Returns:

  • (Integer) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_backups ⇒ Boolean

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

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

Returns:

  • (Boolean) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#daily_automatic_backup_start_time ⇒ String

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.

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_compression_type ⇒ String

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

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

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ String

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

<note markdown=“1”> If you choose ‘PERSISTENT_2`, and you set `FileSystemTypeVersion` to `2.10`, the `CreateFileSystem` operation fails.

</note>

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`)

[1]: docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types [2]: docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#drive_cache_type ⇒ String

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

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#export_path ⇒ String

(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`. 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/`, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

<note markdown=“1”> This parameter is not supported for file systems with a data repository association.

</note>

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#import_path ⇒ 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. 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.

<note markdown=“1”> This parameter is not supported for file systems with a data repository association.

</note>

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#imported_file_chunk_size ⇒ Integer

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

<note markdown=“1”> This parameter is not supported for file systems with a data repository association.

</note>

Returns:

  • (Integer) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#log_configuration ⇒ Types::LustreLogCreateConfiguration

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.

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#per_unit_storage_throughput ⇒ Integer

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.

Returns:

  • (Integer) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#root_squash_configuration ⇒ Types::LustreRootSquashConfiguration

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.

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#weekly_maintenance_start_time ⇒ String

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

Returns:

  • (String) 


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/aws-sdk-fsx/types.rb', line 1761

class CreateFileSystemLustreConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :import_path,
  :export_path,
  :imported_file_chunk_size,
  :deployment_type,
  :auto_import_policy,
  :per_unit_storage_throughput,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration)
  SENSITIVE = []
  include Aws::Structure
end