Struct aws_sdk_fsx::types::FileSystem

#[non_exhaustive]
pub struct FileSystem {

    pub owner_id: Option<String>,
    pub creation_time: Option<DateTime>,
    pub file_system_id: Option<String>,
    pub file_system_type: Option<FileSystemType>,
    pub lifecycle: Option<FileSystemLifecycle>,
    pub failure_details: Option<FileSystemFailureDetails>,
    pub storage_capacity: Option<i32>,
    pub storage_type: Option<StorageType>,
    pub vpc_id: Option<String>,
    pub subnet_ids: Option<Vec<String>>,
    pub network_interface_ids: Option<Vec<String>>,
    pub dns_name: Option<String>,
    pub kms_key_id: Option<String>,
    pub resource_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub windows_configuration: Option<WindowsFileSystemConfiguration>,
    pub lustre_configuration: Option<LustreFileSystemConfiguration>,
    pub administrative_actions: Option<Vec<AdministrativeAction>>,
    pub ontap_configuration: Option<OntapFileSystemConfiguration>,
    pub file_system_type_version: Option<String>,
    pub open_zfs_configuration: Option<OpenZfsFileSystemConfiguration>,
}

A description of a specific Amazon FSx 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.

owner_id: Option<String>

The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

creation_time: Option<DateTime>

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

file_system_id: Option<String>

The system-generated, unique 17-digit ID of the file system.

file_system_type: Option<FileSystemType>

The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

lifecycle: Option<FileSystemLifecycle>

The lifecycle status of the file system. The following are the possible values and what they mean:

• AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

• CREATING - Amazon FSx is creating the new file system.

• DELETING - Amazon FSx is deleting an existing file system.

• FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

• MISCONFIGURED - The file system is in a failed but recoverable state.

• MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

• UPDATING - The file system is undergoing a customer-initiated update.

failure_details: Option<FileSystemFailureDetails>

A structure providing details of any failures that occurred.

storage_capacity: Option<i32>

The storage capacity of the file system in gibibytes (GiB).

Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

storage_type: Option<StorageType>

The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

vpc_id: Option<String>

The ID of the primary virtual private cloud (VPC) for the file system.

subnet_ids: Option<Vec<String>>

Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

network_interface_ids: Option<Vec<String>>

The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

dns_name: Option<String>

The Domain Name System (DNS) name for the file system.

kms_key_id: Option<String>

The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

• Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

  SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

• Amazon FSx for NetApp ONTAP

• Amazon FSx for OpenZFS

• Amazon FSx for Windows File Server

resource_arn: Option<String>

The Amazon Resource Name (ARN) of the file system resource.

tags: Option<Vec<Tag>>

The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

windows_configuration: Option<WindowsFileSystemConfiguration>

The configuration for this Amazon FSx for Windows File Server file system.

lustre_configuration: Option<LustreFileSystemConfiguration>

The configuration for the Amazon FSx for Lustre file system.

administrative_actions: Option<Vec<AdministrativeAction>>

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

ontap_configuration: Option<OntapFileSystemConfiguration>

The configuration for this Amazon FSx for NetApp ONTAP file system.

file_system_type_version: Option<String>

The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

open_zfs_configuration: Option<OpenZfsFileSystemConfiguration>

The configuration for this Amazon FSx for OpenZFS file system.

Implementations

impl FileSystem

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

The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

pub fn creation_time(&self) -> Option<&DateTime>

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

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

The system-generated, unique 17-digit ID of the file system.

pub fn file_system_type(&self) -> Option<&FileSystemType>

The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

pub fn lifecycle(&self) -> Option<&FileSystemLifecycle>

The lifecycle status of the file system. The following are the possible values and what they mean:

• AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

• CREATING - Amazon FSx is creating the new file system.

• DELETING - Amazon FSx is deleting an existing file system.

• FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

• MISCONFIGURED - The file system is in a failed but recoverable state.

• MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

• UPDATING - The file system is undergoing a customer-initiated update.

pub fn failure_details(&self) -> Option<&FileSystemFailureDetails>

A structure providing details of any failures that occurred.

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

The storage capacity of the file system in gibibytes (GiB).

Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

pub fn storage_type(&self) -> Option<&StorageType>

The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

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

The ID of the primary virtual private cloud (VPC) for the file system.

pub fn subnet_ids(&self) -> &[String]

Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subnet_ids.is_none().

pub fn network_interface_ids(&self) -> &[String]

The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .network_interface_ids.is_none().

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

The Domain Name System (DNS) name for the file system.

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

The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

• Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

  SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

• Amazon FSx for NetApp ONTAP

• Amazon FSx for OpenZFS

• Amazon FSx for Windows File Server

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

The Amazon Resource Name (ARN) of the file system resource.

pub fn tags(&self) -> &[Tag]

The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn windows_configuration(&self) -> Option<&WindowsFileSystemConfiguration>

The configuration for this Amazon FSx for Windows File Server file system.

pub fn lustre_configuration(&self) -> Option<&LustreFileSystemConfiguration>

The configuration for the Amazon FSx for Lustre file system.

pub fn administrative_actions(&self) -> &[AdministrativeAction]

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .administrative_actions.is_none().

pub fn ontap_configuration(&self) -> Option<&OntapFileSystemConfiguration>

The configuration for this Amazon FSx for NetApp ONTAP file system.

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

The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

pub fn open_zfs_configuration(&self) -> Option<&OpenZfsFileSystemConfiguration>

The configuration for this Amazon FSx for OpenZFS file system.

impl FileSystem

pub fn builder() -> FileSystemBuilder

Creates a new builder-style object to manufacture FileSystem.

Trait Implementations

impl Clone for FileSystem

fn clone(&self) -> FileSystem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileSystem

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

Formats the value using the given formatter.

impl PartialEq for FileSystem

fn eq(&self, other: &FileSystem) -> 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 FileSystem