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 UpdateFileSystem operation.

  • Method Details

    • 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. For second-generation FSx for ONTAP file systems, you can also decrease the storage capacity. Specifies the storage capacity target value, in GiB, 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, when increasing storage capacity, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. When decreasing storage capacity on second-generation file systems, the target value must be at least 9 percent smaller than the current SSD storage capacity. For more information, see File system storage capacity and 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. For second-generation FSx for ONTAP file systems, you can also decrease the storage capacity. Specifies the storage capacity target value, in GiB, 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, when increasing storage capacity, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. When decreasing storage capacity on second-generation file systems, the target value must be at least 9 percent smaller than the current SSD storage capacity. For more information, see File system storage capacity and 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, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

      Returns:
      The value of the StorageType property for this object.
      See Also:

    • 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, storageType will return StorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

      Returns:
      The value of the StorageType property for this object.
      See Also:

    • fileSystemTypeVersion

      public final 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.

      Returns:
      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.

    • networkType

      public final NetworkType networkType()

      Changes the network type of an FSx for OpenZFS file system.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      Changes the network type of an FSx for OpenZFS file system.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      Changes the network type of an FSx for OpenZFS file system.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      Changes the network type of an FSx for OpenZFS file system.
      See Also:

    • toBuilder

      public UpdateFileSystemRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateFileSystemRequest.Builder,UpdateFileSystemRequest>
      Specified by:
      toBuilder in class FSxRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.