[ aws . ec2 ]

modify-volume

Description

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes in the Amazon EBS User Guide .

When you complete a resize operation on your volume, you need to extend the volume’s file-system size to take advantage of the new storage capacity. For more information, see Extend the file system .

For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide .

With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.

After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.

See also: AWS API Documentation

Synopsis

  modify-volume
[--dry-run | --no-dry-run]
--volume-id <value>
[--size <value>]
[--volume-type <value>]
[--iops <value>]
[--throughput <value>]
[--multi-attach-enabled | --no-multi-attach-enabled]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--dry-run | --no-dry-run (boolean)

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 .

--volume-id (string)

The ID of the volume.

--size (integer)

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.

--volume-type (string)

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.

Possible values:

• standard
• io1
• io2
• gp2
• sc1
• st1
• gp3

--iops (integer)

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 (integer)

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.

--multi-attach-enabled | --no-multi-attach-enabled (boolean)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To modify a volume by changing its size

The following modify-volume example changes the size of the specified volume to 150GB.

Command:

aws ec2 modify-volume --size 150 --volume-id vol-1234567890abcdef0

Output:

{
    "VolumeModification": {
        "TargetSize": 150,
        "TargetVolumeType": "io1",
        "ModificationState": "modifying",
        "VolumeId": " vol-1234567890abcdef0",
        "TargetIops": 100,
        "StartTime": "2019-05-17T11:27:19.000Z",
        "Progress": 0,
        "OriginalVolumeType": "io1",
        "OriginalIops": 100,
        "OriginalSize": 100
    }
}

Example 2: To modify a volume by changing its type, size, and IOPS value

The following modify-volume example changes the volume type to Provisioned IOPS SSD, sets the target IOPS rate to 10000, and sets the volume size to 350GB.

aws ec2 modify-volume \
    --volume-type io1 \
    --iops 10000 \
    --size 350 \
    --volume-id vol-1234567890abcdef0

Output:

{
    "VolumeModification": {
        "TargetSize": 350,
        "TargetVolumeType": "io1",
        "ModificationState": "modifying",
        "VolumeId": "vol-0721c1a9d08c93bf6",
        "TargetIops": 10000,
        "StartTime": "2019-05-17T11:38:57.000Z",
        "Progress": 0,
        "OriginalVolumeType": "gp2",
        "OriginalIops": 150,
        "OriginalSize": 50
    }
}

Output

VolumeModification -> (structure)

Information about the volume modification.

VolumeId -> (string)

The ID of the volume.

ModificationState -> (string)

The current modification state.

StatusMessage -> (string)

A status message about the modification progress or failure.

TargetSize -> (integer)

The target size of the volume, in GiB.

TargetIops -> (integer)

The target IOPS rate of the volume.

TargetVolumeType -> (string)

The target EBS volume type of the volume.

TargetThroughput -> (integer)

The target throughput of the volume, in MiB/s.

TargetMultiAttachEnabled -> (boolean)

The target setting for Amazon EBS Multi-Attach.

OriginalSize -> (integer)

The original size of the volume, in GiB.

OriginalIops -> (integer)

The original IOPS rate of the volume.

OriginalVolumeType -> (string)

The original EBS volume type of the volume.

OriginalThroughput -> (integer)

The original throughput of the volume, in MiB/s.

OriginalMultiAttachEnabled -> (boolean)

The original setting for Amazon EBS Multi-Attach.

Progress -> (long)

The modification progress, from 0 to 100 percent complete.

StartTime -> (timestamp)

The modification start time.

EndTime -> (timestamp)

The modification completion or failure time.