software.amazon.awssdk.services.ec2.model

Interface ModifyVolumeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>, Ec2Request.Builder, SdkBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyVolumeRequest

public static interface ModifyVolumeRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>

Method Summary

Modifier and Type	Method and Description
ModifyVolumeRequest.Builder	iops(Integer iops) The target IOPS rate of the volume.
ModifyVolumeRequest.Builder	multiAttachEnabled(Boolean multiAttachEnabled) Specifies whether to enable Amazon EBS Multi-Attach.
ModifyVolumeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ModifyVolumeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ModifyVolumeRequest.Builder	size(Integer size) The target size of the volume, in GiB.
ModifyVolumeRequest.Builder	throughput(Integer throughput) The target throughput of the volume, in MiB/s.
ModifyVolumeRequest.Builder	volumeId(String volumeId) The ID of the volume.
ModifyVolumeRequest.Builder	volumeType(String volumeType) The target EBS volume type of the volume.
ModifyVolumeRequest.Builder	volumeType(VolumeType volumeType) The target EBS volume type of the volume.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

volumeId

ModifyVolumeRequest.Builder volumeId(String volumeId)

The ID of the volume.

Parameters:

volumeId - The ID of the volume.

Returns:

Returns a reference to this object so that method calls can be chained together.

size

ModifyVolumeRequest.Builder size(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

• io1 and io2: 4-16,384

• st1 and sc1: 125-16,384

• standard: 1-1,024

Default: If no size is specified, the existing size is retained.

Parameters:

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

• io1 and io2: 4-16,384

• st1 and sc1: 125-16,384

• standard: 1-1,024

Default: If no size is specified, the existing size is retained.

Returns:

Returns a reference to this object so that method calls can be chained together.

volumeType

ModifyVolumeRequest.Builder volumeType(String 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: If no type is specified, the existing type is retained.

Parameters:

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: If no type is specified, the existing type is retained.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VolumeType, VolumeType

volumeType

ModifyVolumeRequest.Builder volumeType(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: If no type is specified, the existing type is retained.

Parameters:

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: If no type is specified, the existing type is retained.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VolumeType, VolumeType

iops

ModifyVolumeRequest.Builder iops(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-64,000 IOPS

Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.

Parameters:

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-64,000 IOPS

Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.

Returns:

Returns a reference to this object so that method calls can be chained together.

throughput

ModifyVolumeRequest.Builder throughput(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: If no throughput value is specified, the existing value is retained.

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

Parameters:

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: If no throughput value is specified, the existing value is retained.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

multiAttachEnabled

ModifyVolumeRequest.Builder multiAttachEnabled(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ModifyVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ModifyVolumeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.