Amazon Elastic Compute Cloud
CLI Reference (API Version 2012-04-01)
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-create-tags

Description

Adds or overwrites one or more tags for the specified resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide.

The short version of this command is ec2addtag.

Syntax

ec2-create-tags resource_id [resource_id ...] --tag key[=value] [--tag key[=value] ...]

Options

NameDescriptionRequired

resource_id

AWS-assigned ID of the resource you want to tag. You can specify multiple resources to assign the tags to.

Type: String

Default: None

Example: ami-1a2b3c4d

Yes

--tag key or key=value

Key and optional value of the tag, separated by an equals sign (=). If you don't include a value, we set the value to an empty string.

If you're using the command line tools on a Windows system, you might need to use quotation marks (i.e., "key=value").

Type: String

Default: None

Constraints: Maximum tag key length is 128 characters. Maximum tag value length is 256 characters. Tag keys and values are case sensitive and accept Unicode characters.

Example: --tag stack=Production

Yes

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:

  • TAG identifier

  • Resource type (e.g., instance, image, etc.)

  • Resource ID

  • Tag key

  • Tag value

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example adds (or overwrites) two tags for an AMI and an instance. One of the tags is just a key (webserver), with no value. The other consists of a key (stack) and value (Production). We set the value of the webserver tag to an empty string.

PROMPT> ec2-create-tags ami-1a2b3c4d i-7d3e5a2f --tag webserver --tag stack=Production
TAG  image  ami-1a2b3c4d  webserver
TAG  image  ami-1a2b3c4d  stack  Production
TAG  instance  i-7d3e5a2f  webserver
TAG  instance  i-7d3e5a2f  stack  Production