Amazonka.FSx.Types.FileSystem

Documentation

data FileSystem

A description of a specific Amazon FSx file system.

See: newFileSystem smart constructor.

Constructors

FileSystem'

Fields

• administrativeActions :: Maybe [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.

• creationTime :: Maybe POSIX

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

• dNSName :: Maybe Text

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

• failureDetails :: Maybe FileSystemFailureDetails
• fileSystemId :: Maybe Text

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

• fileSystemType :: Maybe FileSystemType

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

• fileSystemTypeVersion :: Maybe Text

  The Lustre version of the Amazon FSx for Lustre file system, either 2.10 or 2.12.

• kmsKeyId :: Maybe Text

  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
• lifecycle :: Maybe 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.
• lustreConfiguration :: Maybe LustreFileSystemConfiguration
• networkInterfaceIds :: Maybe [Text]

  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.

• ontapConfiguration :: Maybe OntapFileSystemConfiguration

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

• openZFSConfiguration :: Maybe OpenZFSFileSystemConfiguration

  The configuration for this Amazon FSx for OpenZFS file system.

• ownerId :: Maybe Text

  The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.

• resourceARN :: Maybe Text

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

• storageCapacity :: Maybe Natural

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

• storageType :: Maybe 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.

• subnetIds :: Maybe [Text]

  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.

• tags :: Maybe (NonEmpty Tag)

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

• vpcId :: Maybe Text

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

• windowsConfiguration :: Maybe WindowsFileSystemConfiguration

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

Instances

FromJSON FileSystem

Defined in Amazonka.FSx.Types.FileSystem

Methods

parseJSON :: Value -> Parser FileSystem

parseJSONList :: Value -> Parser [FileSystem]

Generic FileSystem

Defined in Amazonka.FSx.Types.FileSystem

Associated Types

type Rep FileSystem :: Type -> Type

Methods

from :: FileSystem -> Rep FileSystem x

to :: Rep FileSystem x -> FileSystem

Read FileSystem

Defined in Amazonka.FSx.Types.FileSystem

Methods

readsPrec :: Int -> ReadS FileSystem

readList :: ReadS [FileSystem]

readPrec :: ReadPrec FileSystem

readListPrec :: ReadPrec [FileSystem]

Show FileSystem

Defined in Amazonka.FSx.Types.FileSystem

Methods

showsPrec :: Int -> FileSystem -> ShowS

show :: FileSystem -> String

showList :: [FileSystem] -> ShowS

NFData FileSystem

Defined in Amazonka.FSx.Types.FileSystem

Methods

rnf :: FileSystem -> ()

Eq FileSystem

Defined in Amazonka.FSx.Types.FileSystem

Methods

(==) :: FileSystem -> FileSystem -> Bool

(/=) :: FileSystem -> FileSystem -> Bool

Hashable FileSystem

Defined in Amazonka.FSx.Types.FileSystem

Methods

hashWithSalt :: Int -> FileSystem -> Int

hash :: FileSystem -> Int

type Rep FileSystem

Defined in Amazonka.FSx.Types.FileSystem

type Rep FileSystem = D1 ('MetaData "FileSystem" "Amazonka.FSx.Types.FileSystem" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "FileSystem'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "administrativeActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdministrativeAction])) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "dNSName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "failureDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSystemFailureDetails)) :*: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "fileSystemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSystemType)) :*: S1 ('MetaSel ('Just "fileSystemTypeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSystemLifecycle)) :*: S1 ('MetaSel ('Just "lustreConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LustreFileSystemConfiguration)))))) :*: (((S1 ('MetaSel ('Just "networkInterfaceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "ontapConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OntapFileSystemConfiguration))) :*: (S1 ('MetaSel ('Just "openZFSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenZFSFileSystemConfiguration)) :*: (S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "storageCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageType)) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "windowsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WindowsFileSystemConfiguration))))))))

newFileSystem :: FileSystem

Create a value of FileSystem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:administrativeActions:FileSystem', fileSystem_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.

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

$sel:dNSName:FileSystem', fileSystem_dNSName - The Domain Name System (DNS) name for the file system.

FileSystem, fileSystem_failureDetails - Undocumented member.

$sel:fileSystemId:FileSystem', fileSystem_fileSystemId - The system-generated, unique 17-digit ID of the file system.

$sel:fileSystemType:FileSystem', fileSystem_fileSystemType - The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

$sel:fileSystemTypeVersion:FileSystem', fileSystem_fileSystemTypeVersion - The Lustre version of the Amazon FSx for Lustre file system, either 2.10 or 2.12.

$sel:kmsKeyId:FileSystem', fileSystem_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

$sel:lifecycle:FileSystem', fileSystem_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.

$sel:lustreConfiguration:FileSystem', fileSystem_lustreConfiguration - Undocumented member.

$sel:networkInterfaceIds:FileSystem', fileSystem_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.

$sel:ontapConfiguration:FileSystem', fileSystem_ontapConfiguration - The configuration for this Amazon FSx for NetApp ONTAP file system.

$sel:openZFSConfiguration:FileSystem', fileSystem_openZFSConfiguration - The configuration for this Amazon FSx for OpenZFS file system.

$sel:ownerId:FileSystem', fileSystem_ownerId - The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.

$sel:resourceARN:FileSystem', fileSystem_resourceARN - The Amazon Resource Name (ARN) of the file system resource.

$sel:storageCapacity:FileSystem', fileSystem_storageCapacity - The storage capacity of the file system in gibibytes (GiB).

$sel:storageType:FileSystem', fileSystem_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.

$sel:subnetIds:FileSystem', fileSystem_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.

$sel:tags:FileSystem', fileSystem_tags - The tags to associate with the file system. For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.

$sel:vpcId:FileSystem', fileSystem_vpcId - The ID of the primary virtual private cloud (VPC) for the file system.

$sel:windowsConfiguration:FileSystem', fileSystem_windowsConfiguration - The configuration for this Amazon FSx for Windows File Server file system.

fileSystem_administrativeActions :: Lens' FileSystem (Maybe [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.

fileSystem_creationTime :: Lens' FileSystem (Maybe UTCTime)

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

fileSystem_dNSName :: Lens' FileSystem (Maybe Text)

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

fileSystem_failureDetails :: Lens' FileSystem (Maybe FileSystemFailureDetails)

Undocumented member.

fileSystem_fileSystemId :: Lens' FileSystem (Maybe Text)

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

fileSystem_fileSystemType :: Lens' FileSystem (Maybe FileSystemType)

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

fileSystem_fileSystemTypeVersion :: Lens' FileSystem (Maybe Text)

The Lustre version of the Amazon FSx for Lustre file system, either 2.10 or 2.12.

fileSystem_kmsKeyId :: Lens' FileSystem (Maybe Text)

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

fileSystem_lifecycle :: Lens' FileSystem (Maybe 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.

fileSystem_lustreConfiguration :: Lens' FileSystem (Maybe LustreFileSystemConfiguration)

Undocumented member.

fileSystem_networkInterfaceIds :: Lens' FileSystem (Maybe [Text])

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.

fileSystem_ontapConfiguration :: Lens' FileSystem (Maybe OntapFileSystemConfiguration)

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

fileSystem_openZFSConfiguration :: Lens' FileSystem (Maybe OpenZFSFileSystemConfiguration)

The configuration for this Amazon FSx for OpenZFS file system.

fileSystem_ownerId :: Lens' FileSystem (Maybe Text)

The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.

fileSystem_resourceARN :: Lens' FileSystem (Maybe Text)

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

fileSystem_storageCapacity :: Lens' FileSystem (Maybe Natural)

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

fileSystem_storageType :: Lens' FileSystem (Maybe 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.

fileSystem_subnetIds :: Lens' FileSystem (Maybe [Text])

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.

fileSystem_tags :: Lens' FileSystem (Maybe (NonEmpty Tag))

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

fileSystem_vpcId :: Lens' FileSystem (Maybe Text)

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

fileSystem_windowsConfiguration :: Lens' FileSystem (Maybe WindowsFileSystemConfiguration)

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