Struct aws_sdk_fsx::types::LustreFileSystemConfiguration

#[non_exhaustive]
pub struct LustreFileSystemConfiguration {
    pub weekly_maintenance_start_time: Option<String>,
    pub data_repository_configuration: Option<DataRepositoryConfiguration>,
    pub deployment_type: Option<LustreDeploymentType>,
    pub per_unit_storage_throughput: Option<i32>,
    pub mount_name: Option<String>,
    pub daily_automatic_backup_start_time: Option<String>,
    pub automatic_backup_retention_days: Option<i32>,
    pub copy_tags_to_backups: Option<bool>,
    pub drive_cache_type: Option<DriveCacheType>,
    pub data_compression_type: Option<DataCompressionType>,
    pub log_configuration: Option<LustreLogConfiguration>,
    pub root_squash_configuration: Option<LustreRootSquashConfiguration>,
}

The configuration for the Amazon FSx for Lustre file system.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

weekly_maintenance_start_time: Option<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.

data_repository_configuration: Option<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 .

deployment_type: Option<LustreDeploymentType>

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.

per_unit_storage_throughput: Option<i32>

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.

mount_name: Option<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.

daily_automatic_backup_start_time: Option<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.

automatic_backup_retention_days: Option<i32>

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.

copy_tags_to_backups: Option<bool>

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)

drive_cache_type: Option<DriveCacheType>

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.

data_compression_type: Option<DataCompressionType>

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.

log_configuration: Option<LustreLogConfiguration>

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

root_squash_configuration: Option<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.

Implementations

impl LustreFileSystemConfiguration

pub fn weekly_maintenance_start_time(&self) -> Option<&str>

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.

pub fn data_repository_configuration( &self ) -> Option<&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 .

pub fn deployment_type(&self) -> Option<&LustreDeploymentType>

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.

pub fn per_unit_storage_throughput(&self) -> Option<i32>

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.

pub fn mount_name(&self) -> Option<&str>

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.

pub fn daily_automatic_backup_start_time(&self) -> Option<&str>

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.

pub fn automatic_backup_retention_days(&self) -> Option<i32>

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.

pub fn copy_tags_to_backups(&self) -> Option<bool>

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)

pub fn drive_cache_type(&self) -> Option<&DriveCacheType>

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.

pub fn data_compression_type(&self) -> Option<&DataCompressionType>

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.

pub fn log_configuration(&self) -> Option<&LustreLogConfiguration>

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

pub fn root_squash_configuration( &self ) -> Option<&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.

impl LustreFileSystemConfiguration

pub fn builder() -> LustreFileSystemConfigurationBuilder

Creates a new builder-style object to manufacture LustreFileSystemConfiguration.

Trait Implementations

impl Clone for LustreFileSystemConfiguration

fn clone(&self) -> LustreFileSystemConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LustreFileSystemConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LustreFileSystemConfiguration

fn eq(&self, other: &LustreFileSystemConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LustreFileSystemConfiguration