AWS Documentation » AWS CloudFormation » User Guide » Template Reference » CloudFormation Helper Scripts Reference » cfn-get-metadata	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

cfn-get-metadata

Description

You can use the cfn-get-metadata helper script to fetch a metadata block from CloudFormation and print it to standard out. You can also print a sub-tree of the metadata block if the you specify a key. However, only top-level keys are supported.

Note

cfn-get-metadata does not require credentials, so you do not need to use the --access-key, --secret-key, or --credential-file options.

Syntax

cfn-get-metadata --access-key access.key \
                 --secret-key secret.key \
                 --credential-file|f credential.file \
                 --access-key|k key \
                 --stack|-s stack.name.or.id \
                 --resource|-r logical.resource.id \
                 --url|-u service.url \
                 --region region

Options

Name	Description	Required
`-s, --stack`	Name of the Stack. Type: String. Default: None Example: `-s { "Ref" : "AWS::StackName" },`	Yes
`-r, --resource`	The logical resource ID of the resource that contains the metadata. Type: String. Example: `-r WebServerHost`	Yes
`--region`	The region to derive the CloudFormation URL from. Type: String. Default: None Example: `--region ", { "Ref" : "AWS::Region" },`	No
`--access-key`	AWS Access Key for an account with permission to call DescribeStackResource on CloudFormation. Type: String. Condition: The credential file parameter supercedes this parameter.	Conditional
`--secret-key`	AWS Secret Key that corresponds to the specified AWS Access Key. Type: String. Condition: The credential file parameter supercedes this parameter.	Conditional
`-f, --credential-file`	A file that contains both a secret key and an access key. Type: String. Condition: The credential file parameter supercedes the --access-key and --secret-key parameters.	Conditional

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...