Interface FileSystemDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<FileSystemDescription.Builder,
,FileSystemDescription> SdkBuilder<FileSystemDescription.Builder,
,FileSystemDescription> SdkPojo
- Enclosing class:
FileSystemDescription
-
Method Summary
Modifier and TypeMethodDescriptionavailabilityZoneId
(String availabilityZoneId) The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems.availabilityZoneName
(String availabilityZoneName) Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems.creationTime
(Instant creationTime) The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).creationToken
(String creationToken) The opaque string specified in the request.A Boolean value that, if true, indicates that the file system is encrypted.fileSystemArn
(String fileSystemArn) The Amazon Resource Name (ARN) for the EFS file system, in the formatarn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.fileSystemId
(String fileSystemId) The ID of the file system, assigned by Amazon EFS.default FileSystemDescription.Builder
fileSystemProtection
(Consumer<FileSystemProtectionDescription.Builder> fileSystemProtection) Describes the protection on the file system.fileSystemProtection
(FileSystemProtectionDescription fileSystemProtection) Describes the protection on the file system.The ID of an KMS key used to protect the encrypted file system.lifeCycleState
(String lifeCycleState) The lifecycle phase of the file system.lifeCycleState
(LifeCycleState lifeCycleState) The lifecycle phase of the file system.You can add tags to a file system, including aName
tag.numberOfMountTargets
(Integer numberOfMountTargets) The current number of mount targets that the file system has.The Amazon Web Services account that created the file system.performanceMode
(String performanceMode) The Performance mode of the file system.performanceMode
(PerformanceMode performanceMode) The Performance mode of the file system.provisionedThroughputInMibps
(Double provisionedThroughputInMibps) The amount of provisioned throughput, measured in MiBps, for the file system.default FileSystemDescription.Builder
sizeInBytes
(Consumer<FileSystemSize.Builder> sizeInBytes) The latest known metered size (in bytes) of data stored in the file system, in itsValue
field, and the time at which that size was determined in itsTimestamp
field.sizeInBytes
(FileSystemSize sizeInBytes) The latest known metered size (in bytes) of data stored in the file system, in itsValue
field, and the time at which that size was determined in itsTimestamp
field.tags
(Collection<Tag> tags) The tags associated with the file system, presented as an array ofTag
objects.tags
(Consumer<Tag.Builder>... tags) The tags associated with the file system, presented as an array ofTag
objects.The tags associated with the file system, presented as an array ofTag
objects.throughputMode
(String throughputMode) Displays the file system's throughput mode.throughputMode
(ThroughputMode throughputMode) Displays the file system's throughput mode.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
ownerId
The Amazon Web Services account that created the file system.
- Parameters:
ownerId
- The Amazon Web Services account that created the file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationToken
The opaque string specified in the request.
- Parameters:
creationToken
- The opaque string specified in the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileSystemId
The ID of the file system, assigned by Amazon EFS.
- Parameters:
fileSystemId
- The ID of the file system, assigned by Amazon EFS.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileSystemArn
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
. Example with sample data:arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
- Parameters:
fileSystemArn
- The Amazon Resource Name (ARN) for the EFS file system, in the formatarn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
. Example with sample data:arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTime
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
- Parameters:
creationTime
- The 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
The lifecycle phase of the file system.
- Parameters:
lifeCycleState
- The lifecycle phase of the file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lifeCycleState
The lifecycle phase of the file system.
- Parameters:
lifeCycleState
- The lifecycle phase of the file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
You can add tags to a file system, including a
Name
tag. For more information, see CreateFileSystem. If the file system has aName
tag, Amazon EFS returns the value in this field.- Parameters:
name
- You can add tags to a file system, including aName
tag. For more information, see CreateFileSystem. If the file system has aName
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
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
- Parameters:
numberOfMountTargets
- The 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
The 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 itsTimestamp
field. TheTimestamp
value is the integer number of seconds since 1970-01-01T00:00:00Z. TheSizeInBytes
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
- The latest known metered size (in bytes) of data stored in the file system, in itsValue
field, and the time at which that size was determined in itsTimestamp
field. TheTimestamp
value is the integer number of seconds since 1970-01-01T00:00:00Z. TheSizeInBytes
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
The latest known metered size (in bytes) of data stored in the file system, in its
This is a convenience method that creates an instance of theValue
field, and the time at which that size was determined in itsTimestamp
field. TheTimestamp
value is the integer number of seconds since 1970-01-01T00:00:00Z. TheSizeInBytes
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.FileSystemSize.Builder
avoiding the need to create one manually viaFileSystemSize.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosizeInBytes(FileSystemSize)
.- Parameters:
sizeInBytes
- a consumer that will call methods onFileSystemSize.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
performanceMode
The Performance mode of the file system.
- Parameters:
performanceMode
- The Performance mode of the file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
performanceMode
The Performance mode of the file system.
- Parameters:
performanceMode
- The Performance mode of the file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The ID of an KMS key used to protect the encrypted file system.
- Parameters:
kmsKeyId
- The ID of an KMS key used to protect the encrypted file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
throughputMode
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
- Parameters:
throughputMode
- Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
throughputMode
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
- Parameters:
throughputMode
- Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
provisionedThroughputInMibps
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set toprovisioned
.- Parameters:
provisionedThroughputInMibps
- The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems usingThroughputMode
set toprovisioned
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZoneName
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
- Parameters:
availabilityZoneName
- Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZoneId
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example,
use1-az1
is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.- Parameters:
availabilityZoneId
- The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example,use1-az1
is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags associated with the file system, presented as an array of
Tag
objects.- Parameters:
tags
- The tags associated with the file system, presented as an array ofTag
objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags associated with the file system, presented as an array of
Tag
objects.- Parameters:
tags
- The tags associated with the file system, presented as an array ofTag
objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags associated with the file system, presented as an array of
This is a convenience method that creates an instance of theTag
objects.Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileSystemProtection
FileSystemDescription.Builder fileSystemProtection(FileSystemProtectionDescription fileSystemProtection) Describes the protection on the file system.
- Parameters:
fileSystemProtection
- Describes the protection on the file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileSystemProtection
default FileSystemDescription.Builder fileSystemProtection(Consumer<FileSystemProtectionDescription.Builder> fileSystemProtection) Describes the protection on the file system.
This is a convenience method that creates an instance of theFileSystemProtectionDescription.Builder
avoiding the need to create one manually viaFileSystemProtectionDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofileSystemProtection(FileSystemProtectionDescription)
.- Parameters:
fileSystemProtection
- a consumer that will call methods onFileSystemProtectionDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-