Class: Aws::FSx::Types::LustreFileSystemConfiguration

Inherits:

Struct

Object
Struct
Aws::FSx::Types::LustreFileSystemConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-fsx/types.rb

Overview

The configuration for the Amazon FSx for Lustre file system.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#automatic_backup_retention_days ⇒ Integer

The number of days to retain automatic backups.
#copy_tags_to_backups ⇒ Boolean

A boolean flag indicating whether tags on the file system are copied to backups.
#daily_automatic_backup_start_time ⇒ String

A recurring daily time, in the format ‘HH:MM`.
#data_compression_type ⇒ String

The data compression configuration for the file system.
#data_repository_configuration ⇒ Types::DataRepositoryConfiguration

The data repository configuration object for Lustre file systems returned in the response of the ‘CreateFileSystem` operation.
#deployment_type ⇒ String

The deployment type of the FSx for Lustre file system.
#drive_cache_type ⇒ String

The type of drive cache used by ‘PERSISTENT_1` file systems that are provisioned with HDD storage devices.
#efa_enabled ⇒ Boolean

Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system.
#log_configuration ⇒ Types::LustreLogConfiguration

The Lustre logging configuration.
#metadata_configuration ⇒ Types::FileSystemLustreMetadataConfiguration

The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a ‘PERSISTENT_2` deployment type.
#mount_name ⇒ String

You use the ‘MountName` value when mounting the file system.
#per_unit_storage_throughput ⇒ Integer

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned.
#root_squash_configuration ⇒ Types::LustreRootSquashConfiguration

The Lustre root squash configuration for an Amazon FSx for Lustre file system.
#weekly_maintenance_start_time ⇒ String

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone.

Instance Attribute Details

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

Returns:

(Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_backups ⇒ `Boolean`

A boolean flag indicating whether tags on the file system are copied to backups. If it’s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn’t specify any 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. (Default = false)

Returns:

(Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  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)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#data_compression_type ⇒ `String`

The data compression configuration for the file system. ‘DataCompressionType` can have the following values:

‘NONE` - Data compression is turned off for the file system.
‘LZ4` - Data compression is turned on with the LZ4 algorithm.

For more information, see [Lustre data compression].

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#data_repository_configuration ⇒ `Types::DataRepositoryConfiguration`

The data repository configuration object for Lustre file systems returned in the response of the ‘CreateFileSystem` operation.

This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

Returns:

(Types::DataRepositoryConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ `String`

The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data.

‘SCRATCH_1` and `SCRATCH_2` deployment types are best suited for 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`.

The ‘PERSISTENT_1` and `PERSISTENT_2` deployment type is used for longer-term storage and workloads and encryption of data in transit. `PERSISTENT_2` offers higher `PerUnitStorageThroughput` (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see [ FSx for Lustre deployment options].

The default is ‘SCRATCH_1`.

[1]: docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  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 `StorageType` is HDD. When set to `READ` the file system has an SSD storage cache that is sized to 20% of the file system’s storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

This parameter is required when ‘StorageType` is set to HDD.

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#efa_enabled ⇒ `Boolean`

Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system.

Returns:

(Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#log_configuration ⇒ `Types::LustreLogConfiguration`

The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

Returns:

(Types::LustreLogConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_configuration ⇒ `Types::FileSystemLustreMetadataConfiguration`

The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a ‘PERSISTENT_2` deployment type.

Returns:

(Types::FileSystemLustreMetadataConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#mount_name ⇒ `String`

You use the ‘MountName` value when mounting the file system.

For the ‘SCRATCH_1` deployment type, this value is always “`fsx`”. For `SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2` deployment types, this value is a string that is unique within an Amazon Web Services Region.

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#per_unit_storage_throughput ⇒ `Integer`

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for ‘PERSISTENT_1` and `PERSISTENT_2` deployment types.

Valid values:

For ‘PERSISTENT_1` SSD storage: 50, 100, 200.
For ‘PERSISTENT_1` HDD storage: 12, 40.
For ‘PERSISTENT_2` SSD storage: 125, 250, 500, 1000.

Returns:

(Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#root_squash_configuration ⇒ `Types::LustreRootSquashConfiguration`

The Lustre root squash configuration for 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:

(Types::LustreRootSquashConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#weekly_maintenance_start_time ⇒ `String`

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, ‘d` is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 6611

class LustreFileSystemConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :data_repository_configuration,
  :deployment_type,
  :per_unit_storage_throughput,
  :mount_name,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :drive_cache_type,
  :data_compression_type,
  :log_configuration,
  :root_squash_configuration,
  :metadata_configuration,
  :efa_enabled)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::FSx::Types::LustreFileSystemConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_backup_retention_days ⇒ Integer

#copy_tags_to_backups ⇒ Boolean

#daily_automatic_backup_start_time ⇒ String

#data_compression_type ⇒ String

#data_repository_configuration ⇒ Types::DataRepositoryConfiguration

#deployment_type ⇒ String

#drive_cache_type ⇒ String

#efa_enabled ⇒ Boolean

#log_configuration ⇒ Types::LustreLogConfiguration

#metadata_configuration ⇒ Types::FileSystemLustreMetadataConfiguration

#mount_name ⇒ String

#per_unit_storage_throughput ⇒ Integer

#root_squash_configuration ⇒ Types::LustreRootSquashConfiguration

#weekly_maintenance_start_time ⇒ String

#automatic_backup_retention_days ⇒ `Integer`

#copy_tags_to_backups ⇒ `Boolean`

#daily_automatic_backup_start_time ⇒ `String`

#data_compression_type ⇒ `String`

#data_repository_configuration ⇒ `Types::DataRepositoryConfiguration`

#deployment_type ⇒ `String`

#drive_cache_type ⇒ `String`

#efa_enabled ⇒ `Boolean`

#log_configuration ⇒ `Types::LustreLogConfiguration`

#metadata_configuration ⇒ `Types::FileSystemLustreMetadataConfiguration`

#mount_name ⇒ `String`

#per_unit_storage_throughput ⇒ `Integer`

#root_squash_configuration ⇒ `Types::LustreRootSquashConfiguration`

#weekly_maintenance_start_time ⇒ `String`