Skip to content
AWS for Query.Farm

aws.cloudformation.get_template_summary

Example SQL Queries

SELECT * FROM
aws.cloudformation.get_template_summary;

Description

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 stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, 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.

Table Definition

Column NameColumn Data Type
call_as Input Column

[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 stack sets 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.

VARCHAR
stack_name Input Column

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.

VARCHAR
stack_set_name Input Column

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

VARCHAR
template_body Input Column

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

VARCHAR
template_summary_config Input Column

Specifies options for the GetTemplateSummary API action.

STRUCT(
    "treat_unrecognized_resource_types_as_warnings" BOOLEAN
)
Show child fields
template_summary_config.treat_unrecognized_resource_types_as_warnings

If set to True, any unrecognized resource types generate warnings and not an error. Any unrecognized resource types are returned in the Warnings output parameter.

template_url Input Column

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide. 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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
capabilities

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

VARCHAR[]
Show child fields
capabilities[]
capabilities_reason

The list of resources that generated the values in the Capabilities response element.

VARCHAR
declared_transforms

A list of the transforms that are declared in the template.

VARCHAR[]
Show child fields
declared_transforms[]
description

The value that's defined in the Description property of the template.

VARCHAR
metadata

The value that's defined for the Metadata property of the template.

VARCHAR
parameters

A list of parameter declarations that describe various properties for each parameter.

STRUCT(
    "parameter_key" VARCHAR,
    "default_value" VARCHAR,
    "parameter_type" VARCHAR,
    "no_echo" BOOLEAN,
    "description" VARCHAR,
    "parameter_constraints" STRUCT(
        "allowed_values" VARCHAR[]
    )
)[]
Show child fields
parameters[]
Show child fields
parameters[].default_value

The default value of the parameter.

parameters[].description

The description that's associate with the parameter.

parameters[].no_echo

Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.

parameters[].parameter_constraints

The criteria that CloudFormation uses to validate parameter values.

Show child fields
parameters[].parameter_constraints.allowed_values[]
parameters[].parameter_key

The name that's associated with the parameter.

parameters[].parameter_type

The type of parameter.

resource_identifier_summaries

A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

STRUCT(
    "resource_type" VARCHAR,
    "logical_resource_ids" VARCHAR[],
    "resource_identifiers" VARCHAR[]
)[]
Show child fields
resource_identifier_summaries[]
Show child fields
resource_identifier_summaries[].logical_resource_ids[]
resource_identifier_summaries[].resource_identifiers[]
resource_identifier_summaries[].resource_type

The template resource type of the target resources, such as AWS::S3::Bucket.

resource_types

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

VARCHAR[]
Show child fields
resource_types[]
version

The Amazon Web Services template format version, which identifies the capabilities of the template.

VARCHAR
warnings

An object containing any warnings returned.

STRUCT(
    "unrecognized_resource_types" VARCHAR[]
)
Show child fields
warnings.unrecognized_resource_types[]