Interface ModifyVolumeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>, Ec2Request.Builder, SdkBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ModifyVolumeRequest
@Mutable @NotThreadSafe public static interface ModifyVolumeRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ModifyVolumeRequest.Builder,ModifyVolumeRequest>

  • Method Details

    • dryRun

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • 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 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.

      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 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:
      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 EBS User Guide.

      Default: 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 EBS User Guide.

      Default: The existing type is retained.

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

    • 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 EBS User Guide.

      Default: 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 EBS User Guide.

      Default: The existing type is retained.

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

    • 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 - 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.

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

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