software.amazon.awssdk.services.efs.model

Class FileSystemDescription

java.lang.Object

software.amazon.awssdk.services.efs.model.FileSystemDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FileSystemDescription.Builder,FileSystemDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class FileSystemDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FileSystemDescription.Builder,FileSystemDescription>

Description of the file system.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileSystemDescription.Builder

Method Summary

Modifier and Type	Method and Description
static FileSystemDescription.Builder	builder()
Instant	creationTime() Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
String	creationToken() Opaque string specified in the request.
Boolean	encrypted() A Boolean value that, if true, indicates that the file system is encrypted.
boolean	equals(Object obj)
String	fileSystemId() ID of the file system, assigned by Amazon EFS.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId() The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
LifeCycleState	lifeCycleState() Lifecycle phase of the file system.
String	lifeCycleStateAsString() Lifecycle phase of the file system.
String	name() You can add tags to a file system, including a Name tag.
Integer	numberOfMountTargets() Current number of mount targets that the file system has.
String	ownerId() AWS account that created the file system.
PerformanceMode	performanceMode() The PerformanceMode of the file system.
String	performanceModeAsString() The PerformanceMode of the file system.
Double	provisionedThroughputInMibps() The throughput, measured in MiB/s, that you want to provision for a file system.
List<SdkField<?>>	sdkFields()
static Class<? extends FileSystemDescription.Builder>	serializableBuilderClass()
FileSystemSize	sizeInBytes() Latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field.
ThroughputMode	throughputMode() The throughput mode for a file system.
String	throughputModeAsString() The throughput mode for a file system.
FileSystemDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

Returns:

AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

creationToken

public String creationToken()

Opaque string specified in the request.

Returns:

Opaque string specified in the request.

fileSystemId

public String fileSystemId()

ID of the file system, assigned by Amazon EFS.

Returns:

ID of the file system, assigned by Amazon EFS.

creationTime

public Instant creationTime()

Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

Returns:

Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

lifeCycleState

public LifeCycleState lifeCycleState()

Lifecycle phase of the file system.

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

Returns:

Lifecycle phase of the file system.

See Also:

LifeCycleState

lifeCycleStateAsString

public String lifeCycleStateAsString()

Lifecycle phase of the file system.

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

Returns:

Lifecycle phase of the file system.

See Also:

LifeCycleState

name

public String name()

You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.

Returns:

You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.

numberOfMountTargets

public Integer numberOfMountTargets()

Current number of mount targets that the file system has. For more information, see CreateMountTarget.

Returns:

Current number of mount targets that the file system has. For more information, see CreateMountTarget.

sizeInBytes

public FileSystemSize sizeInBytes()

Latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.

Returns:

Latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.

performanceMode

public PerformanceMode performanceMode()

The PerformanceMode of the file system.

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

Returns:

The PerformanceMode of the file system.

See Also:

PerformanceMode

performanceModeAsString

public String performanceModeAsString()

The PerformanceMode of the file system.

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

Returns:

The PerformanceMode of the file system.

See Also:

PerformanceMode

encrypted

public Boolean encrypted()

A Boolean value that, if true, indicates that the file system is encrypted.

Returns:

A Boolean value that, if true, indicates that the file system is encrypted.

kmsKeyId

public String kmsKeyId()

The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.

Returns:

The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.

throughputMode

public ThroughputMode throughputMode()

The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.

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

Returns:

The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.

See Also:

ThroughputMode

throughputModeAsString

public String throughputModeAsString()

The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.

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

Returns:

The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.

See Also:

ThroughputMode

provisionedThroughputInMibps

public Double provisionedThroughputInMibps()

The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

Returns:

The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

toBuilder

public FileSystemDescription.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<FileSystemDescription.Builder,FileSystemDescription>

Returns:

a builder for type T

builder

public static FileSystemDescription.Builder builder()

serializableBuilderClass

public static Class<? extends FileSystemDescription.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.