Skip to content

/AWS1/CL_FRMRESOURCECHANGE

The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if you execute this change set.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_policyaction TYPE /AWS1/FRMPOLICYACTION /AWS1/FRMPOLICYACTION

The action that will be taken on the physical resource when the change set is executed.

  • Delete The resource will be deleted.

  • Retain The resource will be retained.

  • Snapshot The resource will have a snapshot taken.

  • ReplaceAndDelete The resource will be replaced and then deleted.

  • ReplaceAndRetain The resource will be replaced and then retained.

  • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

iv_action TYPE /AWS1/FRMCHANGEACTION /AWS1/FRMCHANGEACTION

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), Dynamic (exact action for the resource can't be determined), or SyncWithActual (resource will not be changed, only CloudFormation metadata will change).

iv_logicalresourceid TYPE /AWS1/FRMLOGICALRESOURCEID /AWS1/FRMLOGICALRESOURCEID

The resource's logical ID, which is defined in the stack's template.

iv_physicalresourceid TYPE /AWS1/FRMPHYSICALRESOURCEID /AWS1/FRMPHYSICALRESOURCEID

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

iv_resourcetype TYPE /AWS1/FRMRESOURCETYPE /AWS1/FRMRESOURCETYPE

The type of CloudFormation resource, such as AWS::S3::Bucket.

iv_replacement TYPE /AWS1/FRMREPLACEMENT /AWS1/FRMREPLACEMENT

For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.

it_scope TYPE /AWS1/CL_FRMSCOPE_W=>TT_SCOPE TT_SCOPE

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

iv_resourcedriftstatus TYPE /AWS1/FRMSTACKRESRCDRIFTSTATUS /AWS1/FRMSTACKRESRCDRIFTSTATUS

The drift status of the resource. Valid values:

  • IN_SYNC – The resource matches its template definition.

  • MODIFIED – Resource properties were modified outside CloudFormation.

  • DELETED – The resource was deleted outside CloudFormation.

  • NOT_CHECKED – CloudFormation doesn’t currently return this value.

  • UNKNOWN – Drift status could not be determined.

  • UNSUPPORTED – Resource type does not support actual state comparison.

Only present for drift-aware change sets.

it_resourcedriftignoredattrs TYPE /AWS1/CL_FRMRESDRIFTIGNOREDA00=>TT_RESOURCEDRIFTIGNOREDATTRS TT_RESOURCEDRIFTIGNOREDATTRS

List of resource attributes for which drift was ignored.

it_details TYPE /AWS1/CL_FRMRESOURCECHANGEDET=>TT_RESOURCECHANGEDETAILS TT_RESOURCECHANGEDETAILS

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

iv_changesetid TYPE /AWS1/FRMCHANGESETID /AWS1/FRMCHANGESETID

The change set ID of the nested change set.

io_moduleinfo TYPE REF TO /AWS1/CL_FRMMODULEINFO /AWS1/CL_FRMMODULEINFO

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

iv_beforecontext TYPE /AWS1/FRMBEFORECONTEXT /AWS1/FRMBEFORECONTEXT

An encoded JSON string that contains the context of the resource before the change is executed.

iv_aftercontext TYPE /AWS1/FRMAFTERCONTEXT /AWS1/FRMAFTERCONTEXT

An encoded JSON string that contains the context of the resource after the change is executed.

iv_previousdeploymentcontext TYPE /AWS1/FRMPREVIOUSDEPLOYMENTCTX /AWS1/FRMPREVIOUSDEPLOYMENTCTX

Information about the resource's state from the previous CloudFormation deployment.

Queryable Attributes

PolicyAction

The action that will be taken on the physical resource when the change set is executed.

  • Delete The resource will be deleted.

  • Retain The resource will be retained.

  • Snapshot The resource will have a snapshot taken.

  • ReplaceAndDelete The resource will be replaced and then deleted.

  • ReplaceAndRetain The resource will be replaced and then retained.

  • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

Accessible with the following methods

Method Description
GET_POLICYACTION() Getter for POLICYACTION, with configurable default
ASK_POLICYACTION() Getter for POLICYACTION w/ exceptions if field has no value
HAS_POLICYACTION() Determine if POLICYACTION has a value

Action

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), Dynamic (exact action for the resource can't be determined), or SyncWithActual (resource will not be changed, only CloudFormation metadata will change).

Accessible with the following methods

Method Description
GET_ACTION() Getter for ACTION, with configurable default
ASK_ACTION() Getter for ACTION w/ exceptions if field has no value
HAS_ACTION() Determine if ACTION has a value

LogicalResourceId

The resource's logical ID, which is defined in the stack's template.

Accessible with the following methods

Method Description
GET_LOGICALRESOURCEID() Getter for LOGICALRESOURCEID, with configurable default
ASK_LOGICALRESOURCEID() Getter for LOGICALRESOURCEID w/ exceptions if field has no v
HAS_LOGICALRESOURCEID() Determine if LOGICALRESOURCEID has a value

PhysicalResourceId

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

Accessible with the following methods

Method Description
GET_PHYSICALRESOURCEID() Getter for PHYSICALRESOURCEID, with configurable default
ASK_PHYSICALRESOURCEID() Getter for PHYSICALRESOURCEID w/ exceptions if field has no
HAS_PHYSICALRESOURCEID() Determine if PHYSICALRESOURCEID has a value

ResourceType

The type of CloudFormation resource, such as AWS::S3::Bucket.

Accessible with the following methods

Method Description
GET_RESOURCETYPE() Getter for RESOURCETYPE, with configurable default
ASK_RESOURCETYPE() Getter for RESOURCETYPE w/ exceptions if field has no value
HAS_RESOURCETYPE() Determine if RESOURCETYPE has a value

Replacement

For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.

Accessible with the following methods

Method Description
GET_REPLACEMENT() Getter for REPLACEMENT, with configurable default
ASK_REPLACEMENT() Getter for REPLACEMENT w/ exceptions if field has no value
HAS_REPLACEMENT() Determine if REPLACEMENT has a value

Scope

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

Accessible with the following methods

Method Description
GET_SCOPE() Getter for SCOPE, with configurable default
ASK_SCOPE() Getter for SCOPE w/ exceptions if field has no value
HAS_SCOPE() Determine if SCOPE has a value

ResourceDriftStatus

The drift status of the resource. Valid values:

  • IN_SYNC – The resource matches its template definition.

  • MODIFIED – Resource properties were modified outside CloudFormation.

  • DELETED – The resource was deleted outside CloudFormation.

  • NOT_CHECKED – CloudFormation doesn’t currently return this value.

  • UNKNOWN – Drift status could not be determined.

  • UNSUPPORTED – Resource type does not support actual state comparison.

Only present for drift-aware change sets.

Accessible with the following methods

Method Description
GET_RESOURCEDRIFTSTATUS() Getter for RESOURCEDRIFTSTATUS, with configurable default
ASK_RESOURCEDRIFTSTATUS() Getter for RESOURCEDRIFTSTATUS w/ exceptions if field has no
HAS_RESOURCEDRIFTSTATUS() Determine if RESOURCEDRIFTSTATUS has a value

ResourceDriftIgnoredAttributes

List of resource attributes for which drift was ignored.

Accessible with the following methods

Method Description
GET_RESDRIFTIGNOREDATTRS() Getter for RESOURCEDRIFTIGNOREDATTRS, with configurable defa
ASK_RESDRIFTIGNOREDATTRS() Getter for RESOURCEDRIFTIGNOREDATTRS w/ exceptions if field
HAS_RESDRIFTIGNOREDATTRS() Determine if RESOURCEDRIFTIGNOREDATTRS has a value

Details

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

Accessible with the following methods

Method Description
GET_DETAILS() Getter for DETAILS, with configurable default
ASK_DETAILS() Getter for DETAILS w/ exceptions if field has no value
HAS_DETAILS() Determine if DETAILS has a value

ChangeSetId

The change set ID of the nested 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

ModuleInfo

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

Accessible with the following methods

Method Description
GET_MODULEINFO() Getter for MODULEINFO

BeforeContext

An encoded JSON string that contains the context of the resource before the change is executed.

Accessible with the following methods

Method Description
GET_BEFORECONTEXT() Getter for BEFORECONTEXT, with configurable default
ASK_BEFORECONTEXT() Getter for BEFORECONTEXT w/ exceptions if field has no value
HAS_BEFORECONTEXT() Determine if BEFORECONTEXT has a value

AfterContext

An encoded JSON string that contains the context of the resource after the change is executed.

Accessible with the following methods

Method Description
GET_AFTERCONTEXT() Getter for AFTERCONTEXT, with configurable default
ASK_AFTERCONTEXT() Getter for AFTERCONTEXT w/ exceptions if field has no value
HAS_AFTERCONTEXT() Determine if AFTERCONTEXT has a value

PreviousDeploymentContext

Information about the resource's state from the previous CloudFormation deployment.

Accessible with the following methods

Method Description
GET_PREVIOUSDEPLOYMENTCTX() Getter for PREVIOUSDEPLOYMENTCONTEXT, with configurable defa
ASK_PREVIOUSDEPLOYMENTCTX() Getter for PREVIOUSDEPLOYMENTCONTEXT w/ exceptions if field
HAS_PREVIOUSDEPLOYMENTCTX() Determine if PREVIOUSDEPLOYMENTCONTEXT has a value