template_summaries

Creates, updates, deletes, gets or lists a template_summaries resource.

Overview

Name	template_summaries
Type	Resource
Id	aws.cloudformation.template_summaries

Fields

The following fields are returned by SELECT queries:

get_template_summary

Name	Datatype	Description
line_items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_template_summary	select	region	TemplateBody, TemplateURL, StackName, StackSetName, CallAs, TemplateSummaryConfig	Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or StackSet. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a StackSet, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
CallAs	string	[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, SELF is specified. Use SELF for StackSets with self-managed permissions. If you are signed in to the management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
StackName	string	The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
StackSetName	string	The name or unique ID of the StackSet from which the stack was created. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
TemplateBody	string	Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
TemplateSummaryConfig	object	Specifies options for the GetTemplateSummary API action.
TemplateURL	string	The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https:​//. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

SELECT examples

get_template_summary

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or StackSet. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a StackSet, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.

SELECT
line_items
FROM aws.cloudformation.template_summaries
WHERE region = '{{ region }}' -- required
AND TemplateBody = '{{ TemplateBody }}'
AND TemplateURL = '{{ TemplateURL }}'
AND StackName = '{{ StackName }}'
AND StackSetName = '{{ StackSetName }}'
AND CallAs = '{{ CallAs }}'
AND TemplateSummaryConfig = '{{ TemplateSummaryConfig }}'
;