Amazon Elastic Compute Cloud
CLI Reference (API Version 2013-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

ec2-create-volume

Description

Creates an Amazon EBS volume that can be attached to any instance in the same Availability Zone. Any AWS Marketplace product codes from the snapshot are propagated to the volume. For more information about Amazon EBS, see Amazon Elastic Block Store in the Amazon Elastic Compute Cloud User Guide.

The short version of this command is ec2addvol.

Syntax

ec2-create-volume [--size size | --snapshot snapshot_id [--size size]] --availability-zone zone [--type type [--iops iops]]

Options

NameDescription

-s, --size size

The size of the volume, in GiBs.

Type: String

Valid values: 1-1024

Valid values: If the volume type is io1, the minimum size of the volume is 10 GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Condition: Required unless you're creating the volume from a snapshot.

Required: Conditional

Example: -s 80

--snapshot snapshot_id

The snapshot from which to create the new volume.

Type: String

Default: None

Required: Conditional

Condition: Required if you are creating a volume from a snapshot.

Example: --snapshot snap-78a54011

-z, --availability-zone zone

The Availability Zone in which to create the new volume.

Type: String

Default: None

Required: Yes

Example: -z us-east-1a

-t, --type type

The volume type.

Type: String

Valid values: standard | io1

Default: standard

Required: No

Example: -t io1

-i, --iops iops

The number of I/O operations per second (IOPS) that the volume supports.

Type: Integer

Valid values: Range is 100 to 4000.

Default: None

Required: Conditional

Condition: Required when the volume type is io1; not used with standard volumes.

Example: -iops 500

Common Options

OptionDescription

--region REGION

Overrides the region specified by the EC2_URL environment variable and the URL specified by the -U option.

Default: The value of the EC2_URL environment variable, or us-east-1 if EC2_URL isn't set.

Example: --region eu-west-1

-U, --url URL

The uniform resource locator (URL) of the Amazon EC2 web service entry point.

Default: The value of the EC2_URL environment variable, or https://ec2.amazonaws.com if EC2_URL isn't set.

Example: -U https://ec2.amazonaws.com

-O, --aws-access-key AWS_ACCESS_KEY

The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are.

Default: The value of the AWS_ACCESS_KEY environment variable. If AWS_ACCESS_KEY isn't set, you must specify this option.

Example: -O AKIAIOSFODNN7EXAMPLE

Note

For more information, see the following section, Deprecated Options.

-W, --aws-secret-key AWS_SECRET_KEY

The secret access key associated with your AWS account.

Default: The value of the AWS_SECRET_KEY environment variable. If AWS_SECRET_KEY isn't set, you must specify this option.

Example: -W wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Note

For more information, see the following section, Deprecated Options.

-T, --security-token TOKEN AWS_DELEGATION_TOKEN

The AWS delegation token.

Default: The value of the environment variable (if set).

--connection-timeout TIMEOUT

The connection timeout, in seconds.

Example: --connection-timeout 30

--request-timeout TIMEOUT

The request timeout, in seconds.

Example: --request-timeout 45

-v, --verbose

Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API.

-H, --headers

Includes column headers in the command output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Omits tags for tagged resources.

--debug

Displays internal debugging information. This can assist us when helping you troubleshooting problems.

-?, --help, -h

Displays usage information for the command.

-

Reads arguments from standard input. This is useful when piping the output from one command to the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Deprecated Options

For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.

OptionDescription

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

Output

This command returns a table that contains the following information:

  • The VOLUME identifier

  • The ID of the volume

  • The size of the volume, in GiBs

  • The snapshot from which the volume was created, if applicable

  • The Availability Zone in which the volume was created

  • The volume state (creating, available, in-use, deleting, error)

  • The time stamp when volume creation was initiated

  • The EBS volume type

  • The I/O operations per second (IOPS) of a provisioned IOPS volume

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example creates a new 20 GiB volume in Availability Zone us-east-1a.

PROMPT> ec2-create-volume  --size 20 --availability-zone us-east-1a
VOLUME	vol-1a2b3c4d	20		us-east-1a	creating	YYYY-MM-DDTHH:MM:SS+0000	standard