ec2-create-image

Description

Creates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance. For more information about Amazon EBS-backed AMIs, go to Using Amazon EBS-Backed AMIs and Instances.

	Note
	If you customized your instance with ephemeral storage devices or additional EBS volumes besides the root device, the new AMI contains block device mapping information for those storage devices and volumes. When you then launch an instance from your new AMI, the instance automatically launches with the additional devices and volumes.

The short version of this command is ec2cim.

Syntax

ec2-create-image instance_id --name name [--description description] [--no-reboot]

Options

Name	Description	Required
`instance_id`	The ID of the instance. Type: String Default: None Example: i-10a64379	Yes
`-n, --name` `name`	A name for the new image you're creating. Type: String Default: None Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores(_). Allows spaces if the name is enclosed in quotation marks. Example: -n "Standard Web Server"	Yes
`-d, --description` `description`	A description of the new image. Type: String Default: None Constraints: Up to 255 characters Example: -d Fedora_v11	No
`--no-reboot`	By default this property is set to false, which means Amazon EC2 attempts to cleanly shut down the instance before image creation and reboots the instance afterwards. When set to true, Amazon EC2 does not shut down the instance before creating the image. When this option is used, file system integrity on the created image cannot be guaranteed. Type: Boolean Default: False Example: --no-reboot	No

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-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`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command returns a table that contains the following information:

IMAGE identifier
Unique ID of the newly registered machine image

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example creates an AMI from the i-10a64379 instance.

PROMPT> ec2-create-image i-10a64379 --name "Standard Web Server" --description
							"Standard web server AMI"
IMAGE ami-4fa54026