Interface UpdateFileSystemRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>, FSxRequest.Builder, SdkBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateFileSystemRequest

@Mutable
@NotThreadSafe
public static interface UpdateFileSystemRequest.Builder
extends FSxRequest.Builder, SdkPojo, CopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>

Method Summary

Modifier and Type	Method	Description
UpdateFileSystemRequest.Builder	clientRequestToken(String clientRequestToken)	A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates.
UpdateFileSystemRequest.Builder	fileSystemId(String fileSystemId)	The ID of the file system that you are updating.
UpdateFileSystemRequest.Builder	fileSystemTypeVersion(String fileSystemTypeVersion)	The Lustre version you are updating an FSx for Lustre file system to.
default UpdateFileSystemRequest.Builder	lustreConfiguration(Consumer<UpdateFileSystemLustreConfiguration.Builder> lustreConfiguration)	Sets the value of the LustreConfiguration property for this object.
UpdateFileSystemRequest.Builder	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.
UpdateFileSystemRequest.Builder	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.
UpdateFileSystemRequest.Builder	openZFSConfiguration(UpdateFileSystemOpenZFSConfiguration openZFSConfiguration)	The configuration updates for an FSx for OpenZFS file system.
UpdateFileSystemRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateFileSystemRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateFileSystemRequest.Builder	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.
UpdateFileSystemRequest.Builder	storageType(String storageType)	Sets the value of the StorageType property for this object.
UpdateFileSystemRequest.Builder	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.
UpdateFileSystemRequest.Builder	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, sdkFieldNameToField, sdkFields

Method Details

fileSystemId

UpdateFileSystemRequest.Builder fileSystemId(String 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

UpdateFileSystemRequest.Builder clientRequestToken(String 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

UpdateFileSystemRequest.Builder 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. 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, and PERSISTENT_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, and PERSISTENT_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 the UpdateFileSystemWindowsConfiguration.Builder avoiding the need to create one manually via UpdateFileSystemWindowsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to windowsConfiguration(UpdateFileSystemWindowsConfiguration).

Parameters:

windowsConfiguration - a consumer that will call methods on UpdateFileSystemWindowsConfiguration.Builder

Returns:

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

See Also:

• windowsConfiguration(UpdateFileSystemWindowsConfiguration)

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 the UpdateFileSystemLustreConfiguration.Builder avoiding the need to create one manually via UpdateFileSystemLustreConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lustreConfiguration(UpdateFileSystemLustreConfiguration).

Parameters:

lustreConfiguration - a consumer that will call methods on UpdateFileSystemLustreConfiguration.Builder

Returns:

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

See Also:

• lustreConfiguration(UpdateFileSystemLustreConfiguration)

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 the UpdateFileSystemOntapConfiguration.Builder avoiding the need to create one manually via UpdateFileSystemOntapConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ontapConfiguration(UpdateFileSystemOntapConfiguration).

Parameters:

ontapConfiguration - a consumer that will call methods on UpdateFileSystemOntapConfiguration.Builder

Returns:

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

See Also:

• ontapConfiguration(UpdateFileSystemOntapConfiguration)

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 the UpdateFileSystemOpenZFSConfiguration.Builder avoiding the need to create one manually via UpdateFileSystemOpenZFSConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openZFSConfiguration(UpdateFileSystemOpenZFSConfiguration).

Parameters:

openZFSConfiguration - a consumer that will call methods on UpdateFileSystemOpenZFSConfiguration.Builder

Returns:

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

See Also:

• openZFSConfiguration(UpdateFileSystemOpenZFSConfiguration)

storageType

UpdateFileSystemRequest.Builder storageType(String 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
• StorageType

storageType

UpdateFileSystemRequest.Builder storageType(StorageType 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
• StorageType

fileSystemTypeVersion

UpdateFileSystemRequest.Builder fileSystemTypeVersion(String fileSystemTypeVersion)

The Lustre version you are updating an FSx for Lustre file system to. Valid values are 2.12 and 2.15. The value you choose must be newer than the file system's current Lustre version.

Parameters:

fileSystemTypeVersion - The Lustre version you are updating an FSx for Lustre file system to. Valid values are 2.12 and 2.15. The value you choose must be newer than the file system's current Lustre version.

Returns:

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

overrideConfiguration

UpdateFileSystemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.