FileSystem (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.fsx.model.FileSystem

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<FileSystem.Builder,FileSystem>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FileSystem.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FileSystem.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdministrativeAction>`	`administrativeActions()` A list of administrative actions for the file system that are in process or waiting to be processed.
`static FileSystem.Builder`	`builder()`
`Instant`	`creationTime()` The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
`String`	`dnsName()` The DNS name for the file system.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FileSystemFailureDetails`	`failureDetails()` Returns the value of the FailureDetails property for this object.
`String`	`fileSystemId()` The system-generated, unique 17-digit ID of the file system.
`FileSystemType`	`fileSystemType()` The type of Amazon FSx file system, either `LUSTRE` or `WINDOWS`.
`String`	`fileSystemTypeAsString()` The type of Amazon FSx file system, either `LUSTRE` or `WINDOWS`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdministrativeActions()` Returns true if the AdministrativeActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasNetworkInterfaceIds()` Returns true if the NetworkInterfaceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSubnetIds()` Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsKeyId()` The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest.
`FileSystemLifecycle`	`lifecycle()` The lifecycle status of the file system, following are the possible values and what they mean:
`String`	`lifecycleAsString()` The lifecycle status of the file system, following are the possible values and what they mean:
`LustreFileSystemConfiguration`	`lustreConfiguration()` Returns the value of the LustreConfiguration property for this object.
`List<String>`	`networkInterfaceIds()` The IDs of the elastic network interface from which a specific file system is accessible.
`String`	`ownerId()` The AWS account that created the file system.
`String`	`resourceARN()` The Amazon Resource Name (ARN) for the file system resource.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FileSystem.Builder>`	`serializableBuilderClass()`
`Integer`	`storageCapacity()` The storage capacity of the file system in gibibytes (GiB).
`StorageType`	`storageType()` The storage type of the file system.
`String`	`storageTypeAsString()` The storage type of the file system.
`List<String>`	`subnetIds()` Specifies the IDs of the subnets that the file system is accessible from.
`List<Tag>`	`tags()` The tags to associate with the file system.
`FileSystem.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` The ID of the primary VPC for the file system.
`WindowsFileSystemConfiguration`	`windowsConfiguration()` The configuration for this Microsoft Windows file system.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - ownerId
```
public final String ownerId()
```
    The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.
    
    Returns:
    
    The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS 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, either LUSTRE or WINDOWS.
    
    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, either LUSTRE or WINDOWS.
    
    See Also:
    
    FileSystemType
  - fileSystemTypeAsString
```
public final String fileSystemTypeAsString()
```
    The type of Amazon FSx file system, either LUSTRE or WINDOWS.
    
    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, either LUSTRE or WINDOWS.
    
    See Also:
    
    FileSystemType
  - lifecycle
```
public final FileSystemLifecycle lifecycle()
```
    The lifecycle status of the file system, 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 indicates that the file system is in a failed but recoverable state.
    - UPDATING indicates that 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, 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 indicates that the file system is in a failed but recoverable state.
    
    UPDATING indicates that the file system is undergoing a customer initiated update.
    See Also:
    
    FileSystemLifecycle
  - lifecycleAsString
```
public final String lifecycleAsString()
```
    The lifecycle status of the file system, 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 indicates that the file system is in a failed but recoverable state.
    - UPDATING indicates that 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, 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 indicates that the file system is in a failed but recoverable state.
    
    UPDATING indicates that the file system is undergoing a customer initiated update.
    See Also:
    
    FileSystemLifecycle
  - 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).
    
    Returns:
    
    The storage capacity of the file system in gibibytes (GiB).
  - storageType
```
public final StorageType storageType()
```
    The storage type of the file system. Valid values are SSD and HDD. 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 storage type of the file system. Valid values are SSD and HDD. 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:
    
    StorageType
  - storageTypeAsString
```
public final String storageTypeAsString()
```
    The storage type of the file system. Valid values are SSD and HDD. 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 storage type of the file system. Valid values are SSD and HDD. 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:
    
    StorageType
  - vpcId
```
public final String vpcId()
```
    The ID of the primary VPC for the file system.
    
    Returns:
    
    The ID of the primary VPC for the file system.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - subnetIds
```
public final List<String> subnetIds()
```
    Specifies the IDs of the subnets that the file system is accessible from. For Windows 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 Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSubnetIds() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the IDs of the subnets that the file system is accessible from. For Windows 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 Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.
  - hasNetworkInterfaceIds
```
public final boolean hasNetworkInterfaceIds()
```
    Returns true if the NetworkInterfaceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - networkInterfaceIds
```
public final List<String> networkInterfaceIds()
```
    The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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.
    
    You can use hasNetworkInterfaceIds() to see if a value was sent in this field.
    
    Returns:
    
    The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.
    
    Returns:
    
    The DNS name for the file system.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.
    
    Returns:
    
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.
  - resourceARN
```
public final String resourceARN()
```
    The Amazon Resource Name (ARN) for the file system resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the file system resource.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
  - windowsConfiguration
```
public final WindowsFileSystemConfiguration windowsConfiguration()
```
    The configuration for this Microsoft Windows file system.
    
    Returns:
    
    The configuration for this Microsoft Windows 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()
```
    Returns true if the AdministrativeActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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 Windows file system that you have initiated using the UpdateFileSystem action.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAdministrativeActions() to see if a value was sent in this field.
    
    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 Windows file system that you have initiated using the UpdateFileSystem action.
  - toBuilder
```
public FileSystem.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FileSystem.Builder,FileSystem>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class FileSystem

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ownerId

creationTime

fileSystemId

fileSystemType

fileSystemTypeAsString

lifecycle

lifecycleAsString

failureDetails

storageCapacity

storageType

storageTypeAsString

vpcId

hasSubnetIds

subnetIds

hasNetworkInterfaceIds

networkInterfaceIds

dnsName

kmsKeyId

resourceARN

hasTags

tags

windowsConfiguration

lustreConfiguration

hasAdministrativeActions

administrativeActions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields