Interface UpdateFileSystemRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateFileSystemRequest.Builder,
,UpdateFileSystemRequest> FSxRequest.Builder
,SdkBuilder<UpdateFileSystemRequest.Builder,
,UpdateFileSystemRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateFileSystemRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken
(String clientRequestToken) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates.fileSystemId
(String fileSystemId) The ID of the file system that you are updating.default UpdateFileSystemRequest.Builder
lustreConfiguration
(Consumer<UpdateFileSystemLustreConfiguration.Builder> lustreConfiguration) Sets the value of the LustreConfiguration property for this object.lustreConfiguration
(UpdateFileSystemLustreConfiguration lustreConfiguration) Sets the value of the LustreConfiguration property for this object.default UpdateFileSystemRequest.Builder
ontapConfiguration
(Consumer<UpdateFileSystemOntapConfiguration.Builder> ontapConfiguration) Sets the value of the OntapConfiguration property for this object.ontapConfiguration
(UpdateFileSystemOntapConfiguration ontapConfiguration) Sets the value of the OntapConfiguration property for this object.default UpdateFileSystemRequest.Builder
openZFSConfiguration
(Consumer<UpdateFileSystemOpenZFSConfiguration.Builder> openZFSConfiguration) The configuration updates for an FSx for OpenZFS file system.openZFSConfiguration
(UpdateFileSystemOpenZFSConfiguration openZFSConfiguration) The configuration updates for an FSx for OpenZFS file system.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.storageCapacity
(Integer storageCapacity) Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.storageType
(String storageType) Sets the value of the StorageType property for this object.storageType
(StorageType storageType) Sets the value of the StorageType property for this object.default UpdateFileSystemRequest.Builder
windowsConfiguration
(Consumer<UpdateFileSystemWindowsConfiguration.Builder> windowsConfiguration) The configuration updates for an Amazon FSx for Windows File Server file system.windowsConfiguration
(UpdateFileSystemWindowsConfiguration windowsConfiguration) The configuration updates for an Amazon FSx for Windows File Server file system.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.fsx.model.FSxRequest.Builder
build
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
-
fileSystemId
The ID of the file system that you are updating.
- Parameters:
fileSystemId
- The ID of the file system that you are updating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientRequestToken
A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
- Parameters:
clientRequestToken
- A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageCapacity
Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.
You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Lustre file systems, the storage capacity target value can be the following:
-
For
SCRATCH_2
,PERSISTENT_1
, andPERSISTENT_2 SSD
deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. -
For
PERSISTENT HDD
file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity. -
For
SCRATCH_1
file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput capacity in the FSx for Lustre User Guide.
For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.
For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.
For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
- Parameters:
storageCapacity
- Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Lustre file systems, the storage capacity target value can be the following:
-
For
SCRATCH_2
,PERSISTENT_1
, andPERSISTENT_2 SSD
deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. -
For
PERSISTENT HDD
file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity. -
For
SCRATCH_1
file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput capacity in the FSx for Lustre User Guide.
For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.
For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.
For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
windowsConfiguration
UpdateFileSystemRequest.Builder windowsConfiguration(UpdateFileSystemWindowsConfiguration windowsConfiguration) The configuration updates for an Amazon FSx for Windows File Server file system.
- Parameters:
windowsConfiguration
- The configuration updates for an Amazon FSx for Windows File Server file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
windowsConfiguration
default UpdateFileSystemRequest.Builder windowsConfiguration(Consumer<UpdateFileSystemWindowsConfiguration.Builder> windowsConfiguration) The configuration updates for an Amazon FSx for Windows File Server file system.
This is a convenience method that creates an instance of theUpdateFileSystemWindowsConfiguration.Builder
avoiding the need to create one manually viaUpdateFileSystemWindowsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towindowsConfiguration(UpdateFileSystemWindowsConfiguration)
.- Parameters:
windowsConfiguration
- a consumer that will call methods onUpdateFileSystemWindowsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lustreConfiguration
UpdateFileSystemRequest.Builder lustreConfiguration(UpdateFileSystemLustreConfiguration lustreConfiguration) Sets the value of the LustreConfiguration property for this object.- Parameters:
lustreConfiguration
- The new value for the LustreConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lustreConfiguration
default UpdateFileSystemRequest.Builder lustreConfiguration(Consumer<UpdateFileSystemLustreConfiguration.Builder> lustreConfiguration) Sets the value of the LustreConfiguration property for this object. This is a convenience method that creates an instance of theUpdateFileSystemLustreConfiguration.Builder
avoiding the need to create one manually viaUpdateFileSystemLustreConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolustreConfiguration(UpdateFileSystemLustreConfiguration)
.- Parameters:
lustreConfiguration
- a consumer that will call methods onUpdateFileSystemLustreConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ontapConfiguration
UpdateFileSystemRequest.Builder ontapConfiguration(UpdateFileSystemOntapConfiguration ontapConfiguration) Sets the value of the OntapConfiguration property for this object.- Parameters:
ontapConfiguration
- The new value for the OntapConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ontapConfiguration
default UpdateFileSystemRequest.Builder ontapConfiguration(Consumer<UpdateFileSystemOntapConfiguration.Builder> ontapConfiguration) Sets the value of the OntapConfiguration property for this object. This is a convenience method that creates an instance of theUpdateFileSystemOntapConfiguration.Builder
avoiding the need to create one manually viaUpdateFileSystemOntapConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toontapConfiguration(UpdateFileSystemOntapConfiguration)
.- Parameters:
ontapConfiguration
- a consumer that will call methods onUpdateFileSystemOntapConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
openZFSConfiguration
UpdateFileSystemRequest.Builder openZFSConfiguration(UpdateFileSystemOpenZFSConfiguration openZFSConfiguration) The configuration updates for an FSx for OpenZFS file system.
- Parameters:
openZFSConfiguration
- The configuration updates for an FSx for OpenZFS file system.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openZFSConfiguration
default UpdateFileSystemRequest.Builder openZFSConfiguration(Consumer<UpdateFileSystemOpenZFSConfiguration.Builder> openZFSConfiguration) The configuration updates for an FSx for OpenZFS file system.
This is a convenience method that creates an instance of theUpdateFileSystemOpenZFSConfiguration.Builder
avoiding the need to create one manually viaUpdateFileSystemOpenZFSConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toopenZFSConfiguration(UpdateFileSystemOpenZFSConfiguration)
.- Parameters:
openZFSConfiguration
- a consumer that will call methods onUpdateFileSystemOpenZFSConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
storageType
Sets the value of the StorageType property for this object.- Parameters:
storageType
- The new value for the StorageType property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
storageType
Sets the value of the StorageType property for this object.- Parameters:
storageType
- The new value for the StorageType property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateFileSystemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateFileSystemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-