Table of Contents

Class FileSystem

Namespace
Amazon.FSx.Model
Assembly
AWSSDK.FSx.dll

A description of a specific Amazon FSx file system.

public class FileSystem
Inheritance
FileSystem
Inherited Members

Constructors

FileSystem() 

public FileSystem()

Properties

AdministrativeActions

Gets and sets the property AdministrativeActions.

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. 

public List<AdministrativeAction> AdministrativeActions { get; set; }

Property Value

List<AdministrativeAction>

CreationTime

Gets and sets the property CreationTime.

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

public DateTime CreationTime { get; set; }

Property Value

DateTime

DNSName

Gets and sets the property DNSName.

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

public string DNSName { get; set; }

Property Value

string

FailureDetails

Gets and sets the property FailureDetails.

public FileSystemFailureDetails FailureDetails { get; set; }

Property Value

FileSystemFailureDetails

FileSystemId

Gets and sets the property FileSystemId.

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

public string FileSystemId { get; set; }

Property Value

string

FileSystemType

Gets and sets the property FileSystemType.

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

public FileSystemType FileSystemType { get; set; }

Property Value

FileSystemType

FileSystemTypeVersion

Gets and sets the property FileSystemTypeVersion.

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

public string FileSystemTypeVersion { get; set; }

Property Value

string

KmsKeyId

Gets and sets the property KmsKeyId.

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 

public string KmsKeyId { get; set; }

Property Value

string

Lifecycle

Gets and sets the property Lifecycle.

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. 

public FileSystemLifecycle Lifecycle { get; set; }

Property Value

FileSystemLifecycle

LustreConfiguration

Gets and sets the property LustreConfiguration.

public LustreFileSystemConfiguration LustreConfiguration { get; set; }

Property Value

LustreFileSystemConfiguration

NetworkInterfaceIds

Gets and sets the property NetworkInterfaceIds.

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. 

public List<string> NetworkInterfaceIds { get; set; }

Property Value

List<string>

OntapConfiguration

Gets and sets the property OntapConfiguration.

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

public OntapFileSystemConfiguration OntapConfiguration { get; set; }

Property Value

OntapFileSystemConfiguration

OpenZFSConfiguration

Gets and sets the property OpenZFSConfiguration.

The configuration for this Amazon FSx for OpenZFS file system. 

public OpenZFSFileSystemConfiguration OpenZFSConfiguration { get; set; }

Property Value

OpenZFSFileSystemConfiguration

OwnerId

Gets and sets the property OwnerId.

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. 

public string OwnerId { get; set; }

Property Value

string

ResourceARN

Gets and sets the property ResourceARN.

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

public string ResourceARN { get; set; }

Property Value

string

StorageCapacity

Gets and sets the property StorageCapacity.

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. 

public int StorageCapacity { get; set; }

Property Value

int

StorageType

Gets and sets the property 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. 

public StorageType StorageType { get; set; }

Property Value

StorageType

SubnetIds

Gets and sets the property SubnetIds.

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. 

public List<string> SubnetIds { get; set; }

Property Value

List<string>

Tags

Gets and sets the property Tags.

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. 

public List<Tag> Tags { get; set; }

Property Value

List<Tag>

VpcId

Gets and sets the property VpcId.

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

public string VpcId { get; set; }

Property Value

string

WindowsConfiguration

Gets and sets the property WindowsConfiguration.

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

public WindowsFileSystemConfiguration WindowsConfiguration { get; set; }

Property Value

WindowsFileSystemConfiguration