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("software.amazon.awssdk:codegen") public final class UpdateFileSystemRequest extends FSxRequest implements ToCopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>
The request object for the
UpdateFileSystemoperation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateFileSystemRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateFileSystemRequest.Builderbuilder()StringclientRequestToken()A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfileSystemId()The ID of the file system that you are updating.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()UpdateFileSystemLustreConfigurationlustreConfiguration()Returns the value of the LustreConfiguration property for this object.UpdateFileSystemOntapConfigurationontapConfiguration()Returns the value of the OntapConfiguration property for this object.UpdateFileSystemOpenZFSConfigurationopenZFSConfiguration()The configuration updates for an FSx for OpenZFS file system.List<SdkField<?>>sdkFields()static Class<? extends UpdateFileSystemRequest.Builder>serializableBuilderClass()IntegerstorageCapacity()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.StorageTypestorageType()Returns the value of the StorageType property for this object.StringstorageTypeAsString()Returns the value of the StorageType property for this object.UpdateFileSystemRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.UpdateFileSystemWindowsConfigurationwindowsConfiguration()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()
The ID of the file system that you are updating.
- Returns:
- The ID of the file system that you are updating.
-
clientRequestToken
public final 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.
- Returns:
- 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.
-
storageCapacity
public final 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, andPERSISTENT_2 SSDdeployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. -
For
PERSISTENT HDDfile 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_1file 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:
- 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 SSDdeployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. -
For
PERSISTENT HDDfile 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_1file 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.
-
-
-
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.
-
ontapConfiguration
public final UpdateFileSystemOntapConfiguration ontapConfiguration()
Returns the value of the OntapConfiguration property for this object.- Returns:
- The value of the OntapConfiguration property for this object.
-
openZFSConfiguration
public final UpdateFileSystemOpenZFSConfiguration openZFSConfiguration()
The configuration updates for an FSx for OpenZFS file system.
- Returns:
- The configuration updates for an FSx for OpenZFS file system.
-
storageType
public final StorageType storageType()
Returns the value of the StorageType property for this object.If the service returns an enum value that is not available in the current SDK version,
storageTypewill returnStorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstorageTypeAsString().- Returns:
- The value of the StorageType property for this object.
- See Also:
StorageType
-
storageTypeAsString
public final String storageTypeAsString()
Returns the value of the StorageType property for this object.If the service returns an enum value that is not available in the current SDK version,
storageTypewill returnStorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstorageTypeAsString().- Returns:
- The value of the StorageType property for this object.
- See Also:
StorageType
-
toBuilder
public UpdateFileSystemRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>- Specified by:
toBuilderin classFSxRequest
-
builder
public static UpdateFileSystemRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateFileSystemRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-