Class: Aws::FSx::Types::FileSystem

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

Overview

A description of a specific Amazon FSx file system.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#administrative_actions ⇒ Array<Types::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.

Returns:



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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

Returns:

  • (Time) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dns_name ⇒ String

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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#failure_details ⇒ Types::FileSystemFailureDetails

A structure providing details of any failures that occurred.

Returns:



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_type ⇒ String

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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_type_version ⇒ String

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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ 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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle ⇒ String

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.

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#lustre_configuration ⇒ Types::LustreFileSystemConfiguration

The configuration for the Amazon FSx for Lustre file system.

Returns:



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_ids ⇒ Array<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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html

Returns:

  • (Array<String>) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ontap_configuration ⇒ Types::OntapFileSystemConfiguration

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

Returns:



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configuration ⇒ Types::OpenZFSFileSystemConfiguration

The configuration for this Amazon FSx for OpenZFS file system.

Returns:



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity ⇒ Integer

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.

Returns:

  • (Integer) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

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.

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<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`.

Returns:

  • (Array<String>) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to associate with the file system. For more information, see [Tagging your Amazon EC2 resources] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html

Returns:



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

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

Returns:

  • (String) 


5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#windows_configuration ⇒ Types::WindowsFileSystemConfiguration

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

Returns:



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
 
# File 'lib/aws-sdk-fsx/types.rb', line 5927

class FileSystem < Struct.new(
  :owner_id,
  :creation_time,
  :file_system_id,
  :file_system_type,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :storage_type,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :tags,
  :windows_configuration,
  :lustre_configuration,
  :administrative_actions,
  :ontap_configuration,
  :file_system_type_version,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end