Class ModifyVolumeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyVolumeRequest.Builder,
ModifyVolumeRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ModifyVolumeRequest.Builder
builder()
final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
iops()
The target IOPS rate of the volume.final Boolean
Specifies whether to enable Amazon EBS Multi-Attach.static Class
<? extends ModifyVolumeRequest.Builder> final Integer
size()
The target size of the volume, in GiB.final Integer
The target throughput of the volume, in MiB/s.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
volumeId()
The ID of the volume.final VolumeType
The target EBS volume type of the volume.final String
The target EBS volume type of the volume.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 isUnauthorizedOperation
.- 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 isUnauthorizedOperation
.
-
volumeId
The ID of the volume.
- Returns:
- The ID of the volume.
-
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
andgp3
: 1 - 16,384 GiB -
io1
: 4 - 16,384 GiB -
io2
: 4 - 65,536 GiB -
st1
andsc1
: 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
andgp3
: 1 - 16,384 GiB -
io1
: 4 - 16,384 GiB -
io2
: 4 - 65,536 GiB -
st1
andsc1
: 125 - 16,384 GiB -
standard
: 1 - 1024 GiB
Default: The existing size is retained.
-
-
-
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 returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- 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
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 returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- 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
The target IOPS rate of the volume. This parameter is valid only for
gp3
,io1
, andio2
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
, orgp3
, the default is 3,000.- Returns:
- The target IOPS rate of the volume. This parameter is valid only for
gp3
,io1
, andio2
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
, orgp3
, the default is 3,000. -
-
-
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
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
andio2
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
andio2
volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.
-
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 interfaceToCopyableBuilder<ModifyVolumeRequest.Builder,
ModifyVolumeRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-