Skip to content

/AWS1/CL_FRMTEMPLATESUMMARY

The summary of a generated template.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_generatedtemplateid TYPE /AWS1/FRMGENERATEDTEMPLATEID /AWS1/FRMGENERATEDTEMPLATEID

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 .

iv_generatedtemplatename TYPE /AWS1/FRMGENERATEDTEMPLATENAME /AWS1/FRMGENERATEDTEMPLATENAME

The name of the generated template.

iv_status TYPE /AWS1/FRMGENERATEDTMPLSTATUS /AWS1/FRMGENERATEDTMPLSTATUS

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.

iv_statusreason TYPE /AWS1/FRMTEMPLATESTATUSREASON /AWS1/FRMTEMPLATESTATUSREASON

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

iv_creationtime TYPE /AWS1/FRMCREATIONTIME /AWS1/FRMCREATIONTIME

The time the generated template was created.

iv_lastupdatedtime TYPE /AWS1/FRMLASTUPDATEDTIME /AWS1/FRMLASTUPDATEDTIME

The time the generated template was last updated.

iv_numberofresources TYPE /AWS1/FRMNUMBEROFRESOURCES /AWS1/FRMNUMBEROFRESOURCES

The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.


Queryable Attributes

GeneratedTemplateId

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 .

Accessible with the following methods

Method Description
GET_GENERATEDTEMPLATEID() Getter for GENERATEDTEMPLATEID, with configurable default
ASK_GENERATEDTEMPLATEID() Getter for GENERATEDTEMPLATEID w/ exceptions if field has no
HAS_GENERATEDTEMPLATEID() Determine if GENERATEDTEMPLATEID has a value

GeneratedTemplateName

The name of the generated template.

Accessible with the following methods

Method Description
GET_GENERATEDTEMPLATENAME() Getter for GENERATEDTEMPLATENAME, with configurable default
ASK_GENERATEDTEMPLATENAME() Getter for GENERATEDTEMPLATENAME w/ exceptions if field has
HAS_GENERATEDTEMPLATENAME() Determine if GENERATEDTEMPLATENAME has a value

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

StatusReason

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

Accessible with the following methods

Method Description
GET_STATUSREASON() Getter for STATUSREASON, with configurable default
ASK_STATUSREASON() Getter for STATUSREASON w/ exceptions if field has no value
HAS_STATUSREASON() Determine if STATUSREASON has a value

CreationTime

The time the generated template was created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

LastUpdatedTime

The time the generated template was last updated.

Accessible with the following methods

Method Description
GET_LASTUPDATEDTIME() Getter for LASTUPDATEDTIME, with configurable default
ASK_LASTUPDATEDTIME() Getter for LASTUPDATEDTIME w/ exceptions if field has no val
HAS_LASTUPDATEDTIME() Determine if LASTUPDATEDTIME has a value

NumberOfResources

The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.

Accessible with the following methods

Method Description
GET_NUMBEROFRESOURCES() Getter for NUMBEROFRESOURCES, with configurable default
ASK_NUMBEROFRESOURCES() Getter for NUMBEROFRESOURCES w/ exceptions if field has no v
HAS_NUMBEROFRESOURCES() Determine if NUMBEROFRESOURCES has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_TEMPLATESUMMARIES

TYPES TT_TEMPLATESUMMARIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_FRMTEMPLATESUMMARY WITH DEFAULT KEY
.