| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
cfn-describe-stacks
Describe one or more running stacks.
Note
cfn-describe-stacks will only list stacks that are running, or are in the process of being created or deleted. If you want to list stacks that have already been deleted, use cfn-list-stacks.
Syntax
cfn-describe-stacks [options]
Options
stacknameThe name of the stack you'd like information about. If this option isn't specified, cfn-describe-stacks will list all stacks for the account.
- --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
VALUEas 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
VALUEas the web service region to use. This value can be set by using the environment variable 'EC2_REGION'.- -S, --secret-key
VALUE Specify
VALUEas 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'.
Output
The command returns a table with the following columns:
- NAME
Identifies the entry as a stack
- STACK_ID
Unique identifier for the stack. This column appears only in the
--show-longview.- STATUS
The current status of the stack.
One of:
CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE.- STATUS_REASON
Status reason. This column appears only in the
--show-longview.- DESCRIPTION
Description from template used to create stack.
- PARAMETERS
Parameters provided during stack creation. This column appears only in the
--show-longview.- OUTPUTS
Outputs returned from stack creation.
- CREATED_TIME
Time when the stack was created.
- LAST_UPDATED_TIME
Time when the stack was last updated.
- DISABLE_ROLLBACK
Disable rollback of created resources if the stack creation fails. Normally, when a stack fails, all its resources are deleted. This column indicates whether a resource will not be deleted if the stack fails. This column appears only in the
--show-longview.- TIMEOUT_IN_MINUTES
Stack creation timeout. This column appears only in the
--show-longview.- NOTIFICATION_ARNS
SNS ARNs to receive notification about the stack. This column appears only in the
--show-longview.- TAGS
A set of user-defined Tags associated with this stack. This column appears only in the
--show-longor--show-xmlviews.
Examples
List All Running Stacks
To list all running stacks, simply type cfn-list-stacks with no arguments:
$ cfn-describe-stacks
STACK myGollumWiki CREATE_COMPLETE AWS CloudFormation Sample Template Gol... you create a stack from this template. WebsiteURL=http://myurl.amazonaws.com 2012-07-07T18:11:58Z
STACK myMultiAzWordPress CREATE_IN_PROGRESS AWS CloudFormation Sample Template Wor... you create a stack from this template. 2012-07-07T18:19:36ZList Information About a Particular Running Stack
By supplying the stack ID to cfn-list-stacks, you can get information specific to that stack:
$ cfn-describe-stacks myGollumWiki
STACK myGollumWiki CREATE_COMPLETE AWS CloudFormation Sample Template Gol... you create a stack from this template. WebsiteURL=http://myurl.amazonaws.com 2012-07-07T18:11:58Z
Get a CSV File Suitable for Importing to a Spreadsheet
By supplying the --headers and --show-long arguments, you can create output suitable for importing to a spreadsheet:
$ cfn-describe-stacks --headers --show-long >output.csvThe resulting file, output.csv, will contain a comma-separated-value listing of the
output columns and corresponding data for all running stacks. For example:
