ec2_modify_volume: Modify Volume
In aws.ecx: Communicating with AWS EC2 and ECS using AWS REST APIs

Description Usage Arguments Value VolumeId DryRun Size VolumeType Iops Throughput MultiAttachEnabled

Modify Volume

ec2_modify_volume(
  VolumeId,
  DryRun = NULL,
  Size = NULL,
  VolumeType = NULL,
  Iops = NULL,
  Throughput = NULL,
  MultiAttachEnabled = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

`VolumeId`	Character. The ID of the volume.
`DryRun`	Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
`Size`	Integer. The target size of the volume, in GiB.[optional]
`VolumeType`	Character. The target EBS volume type of the volume.[optional]
`Iops`	Integer. The target IOPS rate of the volume.[optional]
`Throughput`	Integer. The target throughput of the volume, in MiB/s.[optional]
`MultiAttachEnabled`	Logical. Specifies whether to enable Amazon EBS Multi-Attach.[optional]
`simplify`	Logical. Whether to simplify the result and handle `nextToken` in the response[optional]
`others`	Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
`print_on_error`	Logical. Whether to show an error message when a network error occurs.
`retry_time`	Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent `retry_time` times but still not be able to get the response, an error will be thrown.
`network_timeout`	Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
`region`	Character. The region of the AWS service.

A list object or a character vector

The ID of the volume.

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.

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.

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.

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.

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.

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.

aws.ecx documentation built on Jan. 27, 2022, 1:10 a.m.