AWS CloudFormation
User Guide (API Version 2010-05-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

Common Options for CloudFormation CLI Tools

Many CLI tools described in this section accept optional parameters described in this topic. For details, see the reference page for the tool you are using, or type toolname --help on the command-line, where toolname is the name of the command (such as cfn-describe-stacks).

--aws-credential-file VALUE

Location of the file with your AWS credentials. This value can be set automatically by using the environment variable 'AWS_CREDENTIAL_FILE'.

--connection-timeout VALUE

Specify a connection timeout VALUE (in seconds). The default value is '30'.

--delimiter VALUE

Specify the delimiter to use when displaying delimited (long) results.

--headers

If you are displaying tabular or delimited results, it includes the column headers. If you are showing xml results, it returns the HTTP headers from the service request, if applicable. This setting is off by default.

-I, --access-key-id VALUE

Specify VALUE as the AWS Access ID to use.

-K, --ec2-private-key-file-path VALUE

The private key file path. This value can be set automatically by using the environment variable 'EC2_PRIVATE_KEY'.

--region VALUE

Specify region VALUE as the web service region to use. This value can be set by using the environment variable 'EC2_REGION'.

-S, --secret-key VALUE

Specify VALUE as the AWS Secret Key to use.

--show-empty-fields

Show empty fields and rows, using a "(nil)" value. The default is to suppress empty fields or columns.

--show-request

Displays the URL the tools used to call the AWS Service. The default value is 'false'.

--show-table, --show-long, --show-xml, --quiet

Specify how the results are displayed: tabular, delimited (long), xml, or no output (quiet). Tabular shows a subset of the data in fixed column-width form, while long shows all of the returned values delimited by a character. The xml is the raw return from the service, while quiet suppresses all standard output. The default is tabular, or 'show-table'.

-U, --url VALUE

This option will override the URL for the service call with VALUE. This value can be set by using the environment variable 'AWS_CLOUDFORMATION_URL'.