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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ModifyVolumeRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModifyVolumeRequest.Builder`	`builder()`
`Boolean`	`dryRun()`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`iops()`	The target IOPS rate of the volume.
`Boolean`	`multiAttachEnabled()`	Specifies whether to enable Amazon EBS Multi-Attach.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyVolumeRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`size()`	The target size of the volume, in GiB.
`Integer`	`throughput()`	The target throughput of the volume, in MiB/s.
`ModifyVolumeRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`volumeId()`	The ID of the volume.
`VolumeType`	`volumeType()`	The target EBS volume type of the volume.
`String`	`volumeTypeAsString()`	The target EBS volume type of the volume.

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
  - 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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
    
    Default: The existing type is retained.
    
    See Also:
    
    VolumeType
  - volumeTypeAsString
```
public final String volumeTypeAsString()
```
    The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
    
    Default: The existing type is retained.
    
    See Also:
    
    VolumeType
  - 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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
  - toBuilder
```
public ModifyVolumeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - 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)
```
    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

Class ModifyVolumeRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

dryRun

volumeId

size

volumeType

volumeTypeAsString

iops

throughput

multiAttachEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields