software.amazon.awssdk.services.fsx.model

Class UpdateFileSystemRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.fsx.model.FSxRequest

software.amazon.awssdk.services.fsx.model.UpdateFileSystemRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateFileSystemRequest
extends FSxRequest
implements ToCopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>

The request object for the UpdateFileSystem operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateFileSystemRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateFileSystemRequest.Builder	builder()
String	clientRequestToken() A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemId() Identifies the file system that you are updating.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
UpdateFileSystemLustreConfiguration	lustreConfiguration() Returns the value of the LustreConfiguration property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateFileSystemRequest.Builder>	serializableBuilderClass()
Integer	storageCapacity() Use this parameter to increase the storage capacity of an Amazon FSx file system.
UpdateFileSystemRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UpdateFileSystemWindowsConfiguration	windowsConfiguration() The configuration updates for an Amazon FSx for Windows File Server file system.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

fileSystemId

public final String fileSystemId()

Identifies the file system that you are updating.

Returns:

Identifies the file system that you are updating.

clientRequestToken

public final String clientRequestToken()

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Returns:

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

storageCapacity

public final Integer storageCapacity()

Use this parameter to increase the storage capacity of an Amazon FSx file system. Specifies the storage capacity target value, GiB, to increase the storage capacity for the file system that you're updating. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system must have at least 16 MB/s of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 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 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you cannot increase the storage capacity.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

Returns:

Use this parameter to increase the storage capacity of an Amazon FSx file system. Specifies the storage capacity target value, GiB, to increase the storage capacity for the file system that you're updating. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system must have at least 16 MB/s of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 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 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you cannot increase the storage capacity.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

windowsConfiguration

public final UpdateFileSystemWindowsConfiguration windowsConfiguration()

The configuration updates for an Amazon FSx for Windows File Server file system.

Returns:

The configuration updates for an Amazon FSx for Windows File Server file system.

lustreConfiguration

public final UpdateFileSystemLustreConfiguration lustreConfiguration()

Returns the value of the LustreConfiguration property for this object.

Returns:

The value of the LustreConfiguration property for this object.

toBuilder

public UpdateFileSystemRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>

Specified by:

toBuilder in class FSxRequest

builder

public static UpdateFileSystemRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateFileSystemRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo