Amazon Elastic Compute Cloud
CLI Reference (API Version 2011-12-15)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

ec2-bundle-instance

Description

Bundles an Amazon S3-backed Windows instance.

[Note]Note

During bundling, only the root store (C:\) is bundled. Data on the ephemeral stores is not preserved.

This procedure is not applicable for Linux and UNIX instances or Windows instances that use Amazon EBS volumes as their root devices.

The short version of this command is ec2bundle.

Syntax

ec2-bundle-instance instance_id -b bucket -p prefix -o access_key_id {-c policy | -s policy_signature |-w owner_secret_access_key} [-x hours] [--location location] [-B]

Options

NameDescriptionRequired

instance_id

The ID of the instance to bundle.

Type: String

Default: None

Example: i-5e73d509

Yes

-b, --bucket bucket

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

Type: String

Default: None

Example: -b mybucket

Yes

-p, --prefix prefix

Specifies the prefix for the image component names being stored in Amazon S3.

Type: String

Default: None

Example: -p winami

Yes

-o, --owner-akid access_key_id

The Access Key ID of the owner of the Amazon S3 bucket.

Type: String

Default: None

Example: -o AKIADQKE4SARGYLE

Yes

-c, --policy policy

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf. If you provide this parameter, you must also provide either a policy signature, or your Secret Access Key, so we can create a policy signature for you (the Secret Access Key is not passed to EC2). If you do not provide this parameter, the --owner-sak is required, and we generate an upload policy and policy signature for you automatically. For more information about upload policies and how to sign them, go to the sections about policy construction and signatures in the Amazon Simple Storage Service Developer Guide.

Type: String

Default: None

Example: -c upload-policy

Conditional

-s, --policy-signature policy_signature

The Base-64 encoded signature for the S3 upload policy. If you provide the --policy parameter but not --policy-signature, the --owner-sak parameter is required, and we use it to automatically sign the policy.

Type: String

Default: None

Example: -s upload-policy

Conditional

-w, --owner-sak owner_secret_access_key

The AWS Secret Access Key for the owner of the Amazon S3 bucket specified in the -b parameter. This parameter is required in either of these cases:

  • If you don't provide the --policy parameter

  • If you provide the --policy parameter, but don't provide the --policy-signature parameter

The command line tools client uses the Secret Access Key to sign a policy for you, but does not send the Secret Access Key to EC2.

Type: String

Default: None

Example: -w eW91dHViZS5jb20vd2F0Y2g/dj1SU3NKMTlzeTNKSQ==

Conditional

-x, --expires hours

The validity period, in hours, for a generated upload policy.

Type: String

Default: 24

Example:-x 8

No

--location bucket_location

Specifies the location of the destination Amazon S3 bucket.

Type: String

Default: None

Example: --location my-bucket-location

No

-B, --no-bucket-setup

Specifies that no Amazon S3 bucket should be created if one doesn't already exist, and that no attempt should be made to fix incorrect permissions.

Type: Boolean

Default: False

Example: -B

No

Common Options

OptionDescription

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

  • BUNDLE identifier

  • ID of the bundle

  • ID of the instance

  • Bucket name

  • Bundle prefix

  • Bundle start time

  • Bundle update time

  • State

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example bundles an instance.

PROMPT> ec2-bundle-instance  i-12345678 -b mybucket -p winami -o AIDADH4IGTRXXKCD -w eW91dHViZS5jb20vd2F0Y2g/dj1SU3NKMTlzeTNKSQ==
BUNDLE bun-c1a540a8 i-12345678 mybucket winami   2008-09-15T17:15:20+0000 pending