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(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

Method Summary

Modifier and Type	Method and Description
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)
FileSystemFailureDetails	failureDetails() Returns the value of the FailureDetails property for this object.
String	fileSystemId() The eight-digit ID of the file system that was automatically assigned by Amazon FSx.
FileSystemType	fileSystemType() Type of file system.
String	fileSystemTypeAsString() Type of file system.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId() The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.
FileSystemLifecycle	lifecycle() The lifecycle status of the file system.
String	lifecycleAsString() The lifecycle status of the file system.
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 resource ARN of the file system.
List<SdkField<?>>	sdkFields()
static Class<? extends FileSystem.Builder>	serializableBuilderClass()
Integer	storageCapacity() The storage capacity of the file system in gigabytes.
List<String>	subnetIds() The IDs of the subnets to contain the endpoint for the file system.
List<Tag>	tags() The tags to associate with the file system.
FileSystem.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

ownerId

public String ownerId()

The AWS account that created the file system. If the file system was created by an 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 IAM user, the AWS account to which the IAM user belongs is the owner.

creationTime

public 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 String fileSystemId()

The eight-digit ID of the file system that was automatically assigned by Amazon FSx.

Returns:

The eight-digit ID of the file system that was automatically assigned by Amazon FSx.

fileSystemType

public FileSystemType fileSystemType()

Type of file system. Currently the only supported type is 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:

Type of file system. Currently the only supported type is WINDOWS.

See Also:

FileSystemType

fileSystemTypeAsString

public String fileSystemTypeAsString()

Type of file system. Currently the only supported type is 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:

Type of file system. Currently the only supported type is WINDOWS.

See Also:

FileSystemType

lifecycle

public FileSystemLifecycle lifecycle()

The lifecycle status of the file system.

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.

See Also:

FileSystemLifecycle

lifecycleAsString

public String lifecycleAsString()

The lifecycle status of the file system.

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.

See Also:

FileSystemLifecycle

failureDetails

public FileSystemFailureDetails failureDetails()

Returns the value of the FailureDetails property for this object.

Returns:

The value of the FailureDetails property for this object.

storageCapacity

public Integer storageCapacity()

The storage capacity of the file system in gigabytes.

Returns:

The storage capacity of the file system in gigabytes.

vpcId

public String vpcId()

The ID of the primary VPC for the file system.

Returns:

The ID of the primary VPC for the file system.

subnetIds

public List<String> subnetIds()

The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

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

Returns:

The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

networkInterfaceIds

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

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 String dnsName()

The DNS name for the file system.

Returns:

The DNS name for the file system.

kmsKeyId

public String kmsKeyId()

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

Returns:

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

resourceARN

public String resourceARN()

The resource ARN of the file system.

Returns:

The resource ARN of the file system.

tags

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

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 WindowsFileSystemConfiguration windowsConfiguration()

The configuration for this Microsoft Windows file system.

Returns:

The configuration for this Microsoft Windows file system.

lustreConfiguration

public LustreFileSystemConfiguration lustreConfiguration()

Returns the value of the LustreConfiguration property for this object.

Returns:

The value of the LustreConfiguration property for this object.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

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