Class ModifyVolumeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.ModifyVolumeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyVolumeRequest extends Ec2Request implements ToCopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>

  • Method Details

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • volumeId

      public final String volumeId()

      The ID of the volume.

      Returns:
      The ID of the volume.

    • size

      public final Integer size()

      The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

      The following are the supported volumes sizes for each volume type:

      • gp2 and gp3: 1 - 16,384 GiB

      • io1: 4 - 16,384 GiB

      • io2: 4 - 65,536 GiB

      • st1 and sc1: 125 - 16,384 GiB

      • standard: 1 - 1024 GiB

      Default: The existing size is retained.

      Returns:
      The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

      The following are the supported volumes sizes for each volume type:

      • gp2 and gp3: 1 - 16,384 GiB

      • io1: 4 - 16,384 GiB

      • io2: 4 - 65,536 GiB

      • st1 and sc1: 125 - 16,384 GiB

      • standard: 1 - 1024 GiB

      Default: The existing size is retained.

    • volumeType

      public final VolumeType volumeType()

      The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

      Default: The existing type is retained.

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

      Returns:
      The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

      Default: The existing type is retained.

      See Also:

    • volumeTypeAsString

      public final String volumeTypeAsString()

      The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

      Default: The existing type is retained.

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

      Returns:
      The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

      Default: The existing type is retained.

      See Also:

    • iops

      public final Integer iops()

      The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

      The following are the supported values for each volume type:

      • gp3: 3,000 - 16,000 IOPS

      • io1: 100 - 64,000 IOPS

      • io2: 100 - 256,000 IOPS

      For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

      Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.

      Returns:
      The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

      The following are the supported values for each volume type:

      • gp3: 3,000 - 16,000 IOPS

      • io1: 100 - 64,000 IOPS

      • io2: 100 - 256,000 IOPS

      For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

      Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.

    • throughput

      public final Integer throughput()

      The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

      Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.

      Valid Range: Minimum value of 125. Maximum value of 1000.

      Returns:
      The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

      Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.

      Valid Range: Minimum value of 125. Maximum value of 1000.

    • multiAttachEnabled

      public final Boolean multiAttachEnabled()

      Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.

      Returns:
      Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.

    • toBuilder

      public ModifyVolumeRequest.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<ModifyVolumeRequest.Builder,ModifyVolumeRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyVolumeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyVolumeRequest.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.