Skip to content

/AWS1/CL_FRMGETTMPLSUMMOUTPUT

The output for the GetTemplateSummary action.

CONSTRUCTOR

IMPORTING

Optional arguments:

IT_PARAMETERS TYPE /AWS1/CL_FRMPARAMDECLARATION=>TT_PARAMETERDECLARATIONS TT_PARAMETERDECLARATIONS

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

IV_DESCRIPTION TYPE /AWS1/FRMDESCRIPTION /AWS1/FRMDESCRIPTION

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

IT_CAPABILITIES TYPE /AWS1/CL_FRMCAPABILITIES_W=>TT_CAPABILITIES TT_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.

IV_CAPABILITIESREASON TYPE /AWS1/FRMCAPABILITIESREASON /AWS1/FRMCAPABILITIESREASON

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

IT_RESOURCETYPES TYPE /AWS1/CL_FRMRESOURCETYPES_W=>TT_RESOURCETYPES TT_RESOURCETYPES

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.

IV_VERSION TYPE /AWS1/FRMVERSION /AWS1/FRMVERSION

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

IV_METADATA TYPE /AWS1/FRMMETADATA /AWS1/FRMMETADATA

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

IT_DECLAREDTRANSFORMS TYPE /AWS1/CL_FRMTRANSFORMSLIST_W=>TT_TRANSFORMSLIST TT_TRANSFORMSLIST

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

IT_RESOURCEIDSUMMARIES TYPE /AWS1/CL_FRMRESOURCEIDSUMMARY=>TT_RESOURCEIDENTIFIERSUMMARIES TT_RESOURCEIDENTIFIERSUMMARIES

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.

IO_WARNINGS TYPE REF TO /AWS1/CL_FRMWARNINGS /AWS1/CL_FRMWARNINGS

An object containing any warnings returned.


Queryable Attributes

Parameters

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

Accessible with the following methods

Method Description
GET_PARAMETERS() Getter for PARAMETERS, with configurable default
ASK_PARAMETERS() Getter for PARAMETERS w/ exceptions if field has no value
HAS_PARAMETERS() Determine if PARAMETERS has a value

Description

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

Accessible with the following methods

Method Description
GET_DESCRIPTION() Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION() Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION() Determine if DESCRIPTION has a value

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.

Accessible with the following methods

Method Description
GET_CAPABILITIES() Getter for CAPABILITIES, with configurable default
ASK_CAPABILITIES() Getter for CAPABILITIES w/ exceptions if field has no value
HAS_CAPABILITIES() Determine if CAPABILITIES has a value

CapabilitiesReason

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

Accessible with the following methods

Method Description
GET_CAPABILITIESREASON() Getter for CAPABILITIESREASON, with configurable default
ASK_CAPABILITIESREASON() Getter for CAPABILITIESREASON w/ exceptions if field has no
HAS_CAPABILITIESREASON() Determine if CAPABILITIESREASON has a value

ResourceTypes

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.

Accessible with the following methods

Method Description
GET_RESOURCETYPES() Getter for RESOURCETYPES, with configurable default
ASK_RESOURCETYPES() Getter for RESOURCETYPES w/ exceptions if field has no value
HAS_RESOURCETYPES() Determine if RESOURCETYPES has a value

Version

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

Accessible with the following methods

Method Description
GET_VERSION() Getter for VERSION, with configurable default
ASK_VERSION() Getter for VERSION w/ exceptions if field has no value
HAS_VERSION() Determine if VERSION has a value

Metadata

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

Accessible with the following methods

Method Description
GET_METADATA() Getter for METADATA, with configurable default
ASK_METADATA() Getter for METADATA w/ exceptions if field has no value
HAS_METADATA() Determine if METADATA has a value

DeclaredTransforms

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

Accessible with the following methods

Method Description
GET_DECLAREDTRANSFORMS() Getter for DECLAREDTRANSFORMS, with configurable default
ASK_DECLAREDTRANSFORMS() Getter for DECLAREDTRANSFORMS w/ exceptions if field has no
HAS_DECLAREDTRANSFORMS() Determine if DECLAREDTRANSFORMS has a value

ResourceIdentifierSummaries

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.

Accessible with the following methods

Method Description
GET_RESOURCEIDSUMMARIES() Getter for RESOURCEIDENTIFIERSUMMARIES, with configurable de
ASK_RESOURCEIDSUMMARIES() Getter for RESOURCEIDENTIFIERSUMMARIES w/ exceptions if fiel
HAS_RESOURCEIDSUMMARIES() Determine if RESOURCEIDENTIFIERSUMMARIES has a value

Warnings

An object containing any warnings returned.

Accessible with the following methods

Method Description
GET_WARNINGS() Getter for WARNINGS