Skip to content

aws.cloudformation.describe_generated_template

Example SQL Queries

SELECT * FROM
aws.cloudformation.describe_generated_template
WHERE
"generated_template_name" = 'VALUE';

Description

Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.

Table Definition

Column NameColumn Data Type
generated_template_name Required Input Column

The name of the generated template.

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
creation_time

The time the generated template was created.

TIMESTAMP_S
generated_template_id

The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

VARCHAR
last_updated_time

The time the generated template was last updated.

TIMESTAMP_S
progress

An object describing the progress of the template generation.

STRUCT(
"resources_succeeded" BIGINT,
"resources_failed" BIGINT,
"resources_processing" BIGINT,
"resources_pending" BIGINT
)
Show child fields
progress.resources_failed

The number of resources that failed the template generation.

progress.resources_pending

The number of resources that are still pending the template generation.

progress.resources_processing

The number of resources that are in-process for the template generation.

progress.resources_succeeded

The number of resources that succeeded the template generation.

resources

A list of objects describing the details of the resources in the template generation.

STRUCT(
"resource_type" VARCHAR,
"logical_resource_id" VARCHAR,
"resource_identifier" MAP(VARCHAR, VARCHAR),
"resource_status" VARCHAR,
"resource_status_reason" VARCHAR,
"warnings" STRUCT(
"type" VARCHAR,
"properties" STRUCT(
"property_path" VARCHAR,
"required" BOOLEAN,
"description" VARCHAR
)[]
)[]
)[]
Show child fields
resources[]
Show child fields
resources[].logical_resource_id

The logical id for this resource in the final generated template.

resources[].resource_identifier

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

resources[].resource_status

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

resources[].resource_status_reason

The reason for the resource detail, providing more information if a failure happened.

resources[].resource_type

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

resources[].warnings[]
Show child fields
resources[].warnings[].properties[]
Show child fields
resources[].warnings[].properties[].description

The description of the property from the resource provider schema.

resources[].warnings[].properties[].property_path

The path of the property. For example, if this is for the S3Bucket member of the Code property, the property path would be Code/S3Bucket.

resources[].warnings[].properties[].required

If true, the specified property is required.

resources[].warnings[].type

The type of this warning. For more information, see IaC generator and write-only properties in the CloudFormation User Guide.

  • MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties.

  • UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property.

  • MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource, and the type of that property can be any of several types.

Currently the resource and property reference documentation does not indicate if a property uses a type of oneOf or anyOf. You need to look at the resource provider schema.

stack_id

The stack ARN of the base stack if a base stack was provided when generating the template.

VARCHAR
status

The status of the template generation. Supported values are:

  • CreatePending - the creation of the template is pending.

  • CreateInProgress - the creation of the template is in progress.

  • DeletePending - the deletion of the template is pending.

  • DeleteInProgress - the deletion of the template is in progress.

  • UpdatePending - the update of the template is pending.

  • UpdateInProgress - the update of the template is in progress.

  • Failed - the template operation failed.

  • Complete - the template operation is complete.

VARCHAR
status_reason

The reason for the current template generation status. This will provide more details if a failure happened.

VARCHAR
template_configuration

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

STRUCT(
"deletion_policy" VARCHAR,
"update_replace_policy" VARCHAR
)
Show child fields
template_configuration.deletion_policy

The DeletionPolicy assigned to resources in the generated template. Supported values are:

  • DELETE - delete all resources when the stack is deleted.

  • RETAIN - retain all resources when the stack is deleted.

For more information, see DeletionPolicy attribute in the CloudFormation User Guide.

template_configuration.update_replace_policy

The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

  • DELETE - delete all resources when the resource is replaced during an update operation.

  • RETAIN - retain all resources when the resource is replaced during an update operation.

For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

total_warnings

The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

BIGINT