Package software.amazon.awssdk.services.fsx.model

Class FileSystem

java.lang.Object
software.amazon.awssdk.services.fsx.model.FileSystem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FileSystem.Builder,FileSystem>
@Generated("software.amazon.awssdk:codegen") public final class FileSystem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FileSystem.Builder,FileSystem>

A description of a specific Amazon FSx file system.

See Also:

  • Method Details

    • ownerId

      public final String 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.

      Returns:
      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.

    • creationTime

      public final Instant creationTime()

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

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

    • fileSystemId

      public final String fileSystemId()

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

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

    • fileSystemType

      public final FileSystemType fileSystemType()

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

      If the service returns an enum value that is not available in the current SDK version, fileSystemType will return FileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileSystemTypeAsString().

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

    • fileSystemTypeAsString

      public final String fileSystemTypeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, fileSystemType will return FileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileSystemTypeAsString().

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

    • lifecycle

      public final FileSystemLifecycle 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.

      If the service returns an enum value that is not available in the current SDK version, lifecycle will return FileSystemLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().

      Returns:
      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.

      See Also:

    • lifecycleAsString

      public final String lifecycleAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, lifecycle will return FileSystemLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().

      Returns:
      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.

      See Also:

    • failureDetails

      public final FileSystemFailureDetails failureDetails()
      Returns the value of the FailureDetails property for this object.
      Returns:
      The value of the FailureDetails property for this object.

    • storageCapacity

      public final Integer 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.

      Returns:
      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.

    • storageType

      public final StorageType 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.

      If the service returns an enum value that is not available in the current SDK version, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

      Returns:
      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.
      See Also:

    • storageTypeAsString

      public final String storageTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

      Returns:
      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.
      See Also:

    • vpcId

      public final String vpcId()

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

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

    • hasSubnetIds

      public final boolean hasSubnetIds()
      For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • subnetIds

      public final List<String> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

      Returns:
      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.

    • hasNetworkInterfaceIds

      public final boolean hasNetworkInterfaceIds()
      For responses, this returns true if the service returned a value for the NetworkInterfaceIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • networkInterfaceIds

      public final List<String> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNetworkInterfaceIds() method.

      Returns:
      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.

    • dnsName

      public final String dnsName()

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

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

    • kmsKeyId

      public final String 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

      Returns:
      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

    • resourceARN

      public final String resourceARN()

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

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      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.

    • windowsConfiguration

      public final WindowsFileSystemConfiguration windowsConfiguration()

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

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

    • lustreConfiguration

      public final LustreFileSystemConfiguration lustreConfiguration()
      Returns the value of the LustreConfiguration property for this object.
      Returns:
      The value of the LustreConfiguration property for this object.

    • hasAdministrativeActions

      public final boolean hasAdministrativeActions()
      For responses, this returns true if the service returned a value for the AdministrativeActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • administrativeActions

      public final List<AdministrativeAction> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdministrativeActions() method.

      Returns:
      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.

    • ontapConfiguration

      public final OntapFileSystemConfiguration ontapConfiguration()

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

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

    • fileSystemTypeVersion

      public final String fileSystemTypeVersion()

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

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

    • openZFSConfiguration

      public final OpenZFSFileSystemConfiguration openZFSConfiguration()

      The configuration for this Amazon FSx for OpenZFS file system.

      Returns:
      The configuration for this Amazon FSx for OpenZFS file system.

    • toBuilder

      public FileSystem.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FileSystem.Builder,FileSystem>
      Returns:
      a builder for type T

    • builder

      public static FileSystem.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FileSystem.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.