[ aws . cloudformation ]
Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
estimate-template-cost
[--template-body <value>]
[--template-url <value>]
[--parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--template-body
(string)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
Conditional: You must pass
TemplateBody
orTemplateURL
. If both are passed, onlyTemplateBody
is used.
--template-url
(string)
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must pass
TemplateURL
orTemplateBody
. If both are passed, onlyTemplateBody
is used.
--parameters
(list)
A list of
Parameter
structures that specify input parameters.(structure)
The Parameter data type.
ParameterKey -> (string)
The key associated with the parameter. If you don’t specify a key and value for a particular parameter, CloudFormation uses the default value that is specified in your template.
ParameterValue -> (string)
The input value associated with the parameter.
UsePreviousValue -> (boolean)
During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify
true
, do not specify a parameter value.ResolvedValue -> (string)
Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for `
SSM
parameter types <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types>`__ in the template.
Shorthand Syntax:
ParameterKey=string,ParameterValue=string,UsePreviousValue=boolean,ResolvedValue=string ...
JSON Syntax:
[
{
"ParameterKey": "string",
"ParameterValue": "string",
"UsePreviousValue": true|false,
"ResolvedValue": "string"
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To estimate template cost
The following estimate-template-cost
example generates a cost estimate for a template named template.yaml
in the current folder.
aws cloudformation estimate-template-cost \
--template-body file://template.yaml
Output:
{
"Url": "http://calculator.s3.amazonaws.com/calc5.html?key=cloudformation/7870825a-xmpl-4def-92e7-c4f8dd360cca"
}
Url -> (string)
An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.