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-describe-instance-attribute

Description

Returns information about an attribute of an instance. Only one attribute can be specified per call.

The short version of this command is ec2dinatt.

Syntax

ec2-describe-instance-attribute instance_id { --block-device-mapping | --disable-api-termination | --group-id | --instance-initiated-shutdown-behavior | --instance-type | --kernel | --ramdisk | --root-device-name | | --source-dest-check | --user-data }

Options

NameDescriptionRequired

instance_id

The instance ID.

Type: String

Default: None

Example: i-43a4412a

Yes

-b, --block-device-mapping

Describes the mapping that defines native device names to use when exposing virtual devices.

Type: String

Default: None

Example: -b

No

--disable-api-termination

Whether the instance can be terminated using the EC2 API. A value of true means you can't terminate the instance using the API (i.e., the instance is "locked"); a value of false means you can. You must modify this attribute before you can terminate any "locked" instances using the API.

Type: String

Default: None

Example: --disable-api-termination

No

-g, --group-id

Security groups the instance is in.

Type: String

Default: None

Example: -g

No

--instance-initiated-shutdown-behavior

If an instance shutdown is initiated, this determines whether the instance stops or terminates.

Type: String

Default: None

Example: --instance-initiated-shutdown-behavior

No

-t, --instance-type

The instance type of the instance.

Type: String

Example: -t

No

--kernel

Describes the ID of the kernel associated with the AMI.

Type: String

Default: None

Example: --kernel

No

--ramdisk

Describes the ID of the RAM disk associated with the AMI.

Type: String

Default: None

Example: --ramdisk

No

--root-device-name

The root device name (e.g., /dev/sda1).

Type: String

Default: None

Example: --root-device-name

No

--source-dest-check

This attribute exists to enable a Network Address Translation (NAT) instance in a VPC to perform NAT. The attribute controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, go to NAT Instances in the Amazon Virtual Private Cloud User Guide.

Type: String

Default: None

Example: --source-dest-check

No

--user-data

User data made available to the instance.

Type: String

Default: None

Example: --user-data

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

  • Attribute type identifier

  • ID of the instances

  • Attribute or attribute list item value

  • For a block device mapping, the returned information includes the BLOCKDEVICE identifier, the device name, the volume ID, and the timestamp

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example lists the kernel ID of the i-10a64379 instance.

PROMPT> ec2-describe-instance-attribute i-10a64379 --kernel
kernel	i-10a64379	aki-f70657b2