/AWS1/CL_FRMSTACK

The Stack data type.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_STACKNAME TYPE /AWS1/FRMSTACKNAME /AWS1/FRMSTACKNAME

The name associated with the stack.

IV_CREATIONTIME TYPE /AWS1/FRMCREATIONTIME /AWS1/FRMCREATIONTIME

The time at which the stack was created.

IV_STACKSTATUS TYPE /AWS1/FRMSTACKSTATUS /AWS1/FRMSTACKSTATUS

Current status of the stack.

Optional arguments:

IV_STACKID TYPE /AWS1/FRMSTACKID /AWS1/FRMSTACKID

Unique identifier of the stack.

IV_CHANGESETID TYPE /AWS1/FRMCHANGESETID /AWS1/FRMCHANGESETID

The unique ID of the change set.

IV_DESCRIPTION TYPE /AWS1/FRMDESCRIPTION /AWS1/FRMDESCRIPTION

A user-defined description associated with the stack.

IT_PARAMETERS TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS TT_PARAMETERS

A list of Parameter structures.

IV_DELETIONTIME TYPE /AWS1/FRMDELETIONTIME /AWS1/FRMDELETIONTIME

The time the stack was deleted.

IV_LASTUPDATEDTIME TYPE /AWS1/FRMLASTUPDATEDTIME /AWS1/FRMLASTUPDATEDTIME

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

IO_ROLLBACKCONFIGURATION TYPE REF TO /AWS1/CL_FRMROLLBACKCONF /AWS1/CL_FRMROLLBACKCONF

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

IV_STACKSTATUSREASON TYPE /AWS1/FRMSTACKSTATUSREASON /AWS1/FRMSTACKSTATUSREASON

Success/failure message associated with the stack status.

IV_DISABLEROLLBACK TYPE /AWS1/FRMDISABLEROLLBACK /AWS1/FRMDISABLEROLLBACK

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback.

• false: enable rollback.

IT_NOTIFICATIONARNS TYPE /AWS1/CL_FRMNOTIFICATIONARNS_W=>TT_NOTIFICATIONARNS TT_NOTIFICATIONARNS

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

IV_TIMEOUTINMINUTES TYPE /AWS1/FRMTIMEOUTMINUTES /AWS1/FRMTIMEOUTMINUTES

The amount of time within which stack creation should complete.

IT_CAPABILITIES TYPE /AWS1/CL_FRMCAPABILITIES_W=>TT_CAPABILITIES TT_CAPABILITIES

The capabilities allowed in the stack.

IT_OUTPUTS TYPE /AWS1/CL_FRMOUTPUT=>TT_OUTPUTS TT_OUTPUTS

A list of output structures.

IV_ROLEARN TYPE /AWS1/FRMROLEARN /AWS1/FRMROLEARN

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

IT_TAGS TYPE /AWS1/CL_FRMTAG=>TT_TAGS TT_TAGS

A list of Tags that specify information about the stack.

IV_ENBTERMINATIONPROTECTION TYPE /AWS1/FRMENBTERMINATIONPROTE00 /AWS1/FRMENBTERMINATIONPROTE00

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

IV_PARENTID TYPE /AWS1/FRMSTACKID /AWS1/FRMSTACKID

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

IV_ROOTID TYPE /AWS1/FRMSTACKID /AWS1/FRMSTACKID

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

IO_DRIFTINFORMATION TYPE REF TO /AWS1/CL_FRMSTACKDRIFTINFMTION /AWS1/CL_FRMSTACKDRIFTINFMTION

Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

IV_RETAINEXCEPTONCREATE TYPE /AWS1/FRMRETAINEXCEPTONCREATE /AWS1/FRMRETAINEXCEPTONCREATE

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

IV_DELETIONMODE TYPE /AWS1/FRMDELETIONMODE /AWS1/FRMDELETIONMODE

Specifies the deletion mode for the stack. Possible values are:

• STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

• FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

IV_DETAILEDSTATUS TYPE /AWS1/FRMDETAILEDSTATUS /AWS1/FRMDETAILEDSTATUS

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

---

Queryable Attributes

StackId

Unique identifier of the stack.

Accessible with the following methods

Method	Description
GET_STACKID()	Getter for STACKID, with configurable default
ASK_STACKID()	Getter for STACKID w/ exceptions if field has no value
HAS_STACKID()	Determine if STACKID has a value

StackName

The name associated with the stack.

Accessible with the following methods

Method	Description
GET_STACKNAME()	Getter for STACKNAME, with configurable default
ASK_STACKNAME()	Getter for STACKNAME w/ exceptions if field has no value
HAS_STACKNAME()	Determine if STACKNAME has a value

ChangeSetId

The unique ID of the change set.

Accessible with the following methods

Method	Description
GET_CHANGESETID()	Getter for CHANGESETID, with configurable default
ASK_CHANGESETID()	Getter for CHANGESETID w/ exceptions if field has no value
HAS_CHANGESETID()	Determine if CHANGESETID has a value

Description

A user-defined description associated with the stack.

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

Parameters

A list of Parameter structures.

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

CreationTime

The time at which the stack 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

DeletionTime

The time the stack was deleted.

Accessible with the following methods

Method	Description
GET_DELETIONTIME()	Getter for DELETIONTIME, with configurable default
ASK_DELETIONTIME()	Getter for DELETIONTIME w/ exceptions if field has no value
HAS_DELETIONTIME()	Determine if DELETIONTIME has a value

LastUpdatedTime

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

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

RollbackConfiguration

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Accessible with the following methods

Method	Description
GET_ROLLBACKCONFIGURATION()	Getter for ROLLBACKCONFIGURATION

StackStatus

Current status of the stack.

Accessible with the following methods

Method	Description
GET_STACKSTATUS()	Getter for STACKSTATUS, with configurable default
ASK_STACKSTATUS()	Getter for STACKSTATUS w/ exceptions if field has no value
HAS_STACKSTATUS()	Determine if STACKSTATUS has a value

StackStatusReason

Success/failure message associated with the stack status.

Accessible with the following methods

Method	Description
GET_STACKSTATUSREASON()	Getter for STACKSTATUSREASON, with configurable default
ASK_STACKSTATUSREASON()	Getter for STACKSTATUSREASON w/ exceptions if field has no v
HAS_STACKSTATUSREASON()	Determine if STACKSTATUSREASON has a value

DisableRollback

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback.

• false: enable rollback.

Accessible with the following methods

Method	Description
GET_DISABLEROLLBACK()	Getter for DISABLEROLLBACK, with configurable default
ASK_DISABLEROLLBACK()	Getter for DISABLEROLLBACK w/ exceptions if field has no val
HAS_DISABLEROLLBACK()	Determine if DISABLEROLLBACK has a value

NotificationARNs

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

Accessible with the following methods

Method	Description
GET_NOTIFICATIONARNS()	Getter for NOTIFICATIONARNS, with configurable default
ASK_NOTIFICATIONARNS()	Getter for NOTIFICATIONARNS w/ exceptions if field has no va
HAS_NOTIFICATIONARNS()	Determine if NOTIFICATIONARNS has a value

TimeoutInMinutes

The amount of time within which stack creation should complete.

Accessible with the following methods

Method	Description
GET_TIMEOUTINMINUTES()	Getter for TIMEOUTINMINUTES, with configurable default
ASK_TIMEOUTINMINUTES()	Getter for TIMEOUTINMINUTES w/ exceptions if field has no va
HAS_TIMEOUTINMINUTES()	Determine if TIMEOUTINMINUTES has a value

Capabilities

The capabilities allowed in the stack.

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

Outputs

A list of output structures.

Accessible with the following methods

Method	Description
GET_OUTPUTS()	Getter for OUTPUTS, with configurable default
ASK_OUTPUTS()	Getter for OUTPUTS w/ exceptions if field has no value
HAS_OUTPUTS()	Determine if OUTPUTS has a value

RoleARN

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

Accessible with the following methods

Method	Description
GET_ROLEARN()	Getter for ROLEARN, with configurable default
ASK_ROLEARN()	Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN()	Determine if ROLEARN has a value

Tags

A list of Tags that specify information about the stack.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

EnableTerminationProtection

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

Accessible with the following methods

Method	Description
GET_ENBTERMINATIONPROTECTION()	Getter for ENABLETERMINATIONPROTECTION, with configurable de
ASK_ENBTERMINATIONPROTECTION()	Getter for ENABLETERMINATIONPROTECTION w/ exceptions if fiel
HAS_ENBTERMINATIONPROTECTION()	Determine if ENABLETERMINATIONPROTECTION has a value

ParentId

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

Accessible with the following methods

Method	Description
GET_PARENTID()	Getter for PARENTID, with configurable default
ASK_PARENTID()	Getter for PARENTID w/ exceptions if field has no value
HAS_PARENTID()	Determine if PARENTID has a value

RootId

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

Accessible with the following methods

Method	Description
GET_ROOTID()	Getter for ROOTID, with configurable default
ASK_ROOTID()	Getter for ROOTID w/ exceptions if field has no value
HAS_ROOTID()	Determine if ROOTID has a value

DriftInformation

Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Accessible with the following methods

Method	Description
GET_DRIFTINFORMATION()	Getter for DRIFTINFORMATION

RetainExceptOnCreate

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

Accessible with the following methods

Method	Description
GET_RETAINEXCEPTONCREATE()	Getter for RETAINEXCEPTONCREATE, with configurable default
ASK_RETAINEXCEPTONCREATE()	Getter for RETAINEXCEPTONCREATE w/ exceptions if field has n
HAS_RETAINEXCEPTONCREATE()	Determine if RETAINEXCEPTONCREATE has a value

DeletionMode

Specifies the deletion mode for the stack. Possible values are:

• STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

• FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

Accessible with the following methods

Method	Description
GET_DELETIONMODE()	Getter for DELETIONMODE, with configurable default
ASK_DELETIONMODE()	Getter for DELETIONMODE w/ exceptions if field has no value
HAS_DELETIONMODE()	Determine if DELETIONMODE has a value

DetailedStatus

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

Accessible with the following methods

Method	Description
GET_DETAILEDSTATUS()	Getter for DETAILEDSTATUS, with configurable default
ASK_DETAILEDSTATUS()	Getter for DETAILEDSTATUS w/ exceptions if field has no valu
HAS_DETAILEDSTATUS()	Determine if DETAILEDSTATUS 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_STACKS

TYPES TT_STACKS TYPE STANDARD TABLE OF REF TO /AWS1/CL_FRMSTACK WITH DEFAULT KEY
.