software.amazon.awssdk.services.efs.model

Interface FileSystemDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FileSystemDescription.Builder,FileSystemDescription>, SdkBuilder<FileSystemDescription.Builder,FileSystemDescription>, SdkPojo

Enclosing class:

FileSystemDescription

public static interface FileSystemDescription.Builder
extends SdkPojo, CopyableBuilder<FileSystemDescription.Builder,FileSystemDescription>

Method Summary

Modifier and Type	Method and Description
FileSystemDescription.Builder	creationTime(Instant creationTime) Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
FileSystemDescription.Builder	creationToken(String creationToken) Opaque string specified in the request.
FileSystemDescription.Builder	encrypted(Boolean encrypted) A Boolean value that, if true, indicates that the file system is encrypted.
FileSystemDescription.Builder	fileSystemId(String fileSystemId) ID of the file system, assigned by Amazon EFS.
FileSystemDescription.Builder	kmsKeyId(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.
FileSystemDescription.Builder	lifeCycleState(LifeCycleState lifeCycleState) Lifecycle phase of the file system.
FileSystemDescription.Builder	lifeCycleState(String lifeCycleState) Lifecycle phase of the file system.
FileSystemDescription.Builder	name(String name) You can add tags to a file system, including a Name tag.
FileSystemDescription.Builder	numberOfMountTargets(Integer numberOfMountTargets) Current number of mount targets that the file system has.
FileSystemDescription.Builder	ownerId(String ownerId) AWS account that created the file system.
FileSystemDescription.Builder	performanceMode(PerformanceMode performanceMode) The PerformanceMode of the file system.
FileSystemDescription.Builder	performanceMode(String performanceMode) The PerformanceMode of the file system.
FileSystemDescription.Builder	provisionedThroughputInMibps(Double provisionedThroughputInMibps) The throughput, measured in MiB/s, that you want to provision for a file system.
default FileSystemDescription.Builder	sizeInBytes(Consumer<FileSystemSize.Builder> 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.
FileSystemDescription.Builder	sizeInBytes(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.
FileSystemDescription.Builder	throughputMode(String throughputMode) The throughput mode for a file system.
FileSystemDescription.Builder	throughputMode(ThroughputMode throughputMode) The throughput mode for a file system.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

ownerId

FileSystemDescription.Builder ownerId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

creationToken

FileSystemDescription.Builder creationToken(String creationToken)

Opaque string specified in the request.

Parameters:

creationToken - Opaque string specified in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

fileSystemId

FileSystemDescription.Builder fileSystemId(String fileSystemId)

ID of the file system, assigned by Amazon EFS.

Parameters:

fileSystemId - ID of the file system, assigned by Amazon EFS.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

FileSystemDescription.Builder creationTime(Instant creationTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

lifeCycleState

FileSystemDescription.Builder lifeCycleState(String lifeCycleState)

Lifecycle phase of the file system.

Parameters:

lifeCycleState - Lifecycle phase of the file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LifeCycleState, LifeCycleState

lifeCycleState

FileSystemDescription.Builder lifeCycleState(LifeCycleState lifeCycleState)

Lifecycle phase of the file system.

Parameters:

lifeCycleState - Lifecycle phase of the file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LifeCycleState, LifeCycleState

name

FileSystemDescription.Builder name(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

numberOfMountTargets

FileSystemDescription.Builder numberOfMountTargets(Integer numberOfMountTargets)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sizeInBytes

FileSystemDescription.Builder sizeInBytes(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sizeInBytes

default FileSystemDescription.Builder sizeInBytes(Consumer<FileSystemSize.Builder> 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.

This is a convenience that creates an instance of the FileSystemSize.Builder avoiding the need to create one manually via FileSystemSize.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sizeInBytes(FileSystemSize).

Parameters:

sizeInBytes - a consumer that will call methods on FileSystemSize.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sizeInBytes(FileSystemSize)

performanceMode

FileSystemDescription.Builder performanceMode(String performanceMode)

The PerformanceMode of the file system.

Parameters:

performanceMode - The PerformanceMode of the file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PerformanceMode, PerformanceMode

performanceMode

FileSystemDescription.Builder performanceMode(PerformanceMode performanceMode)

The PerformanceMode of the file system.

Parameters:

performanceMode - The PerformanceMode of the file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PerformanceMode, PerformanceMode

encrypted

FileSystemDescription.Builder encrypted(Boolean encrypted)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

FileSystemDescription.Builder kmsKeyId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

throughputMode

FileSystemDescription.Builder throughputMode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThroughputMode, ThroughputMode

throughputMode

FileSystemDescription.Builder throughputMode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThroughputMode, ThroughputMode

provisionedThroughputInMibps

FileSystemDescription.Builder provisionedThroughputInMibps(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.