Skip to content

/AWS1/CL_FRMRESOURCETARGETDEFN

The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_attribute TYPE /AWS1/FRMRESOURCEATTRIBUTE /AWS1/FRMRESOURCEATTRIBUTE

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

iv_name TYPE /AWS1/FRMPROPERTYNAME /AWS1/FRMPROPERTYNAME

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

iv_requiresrecreation TYPE /AWS1/FRMREQUIRESRECREATION /AWS1/FRMREQUIRESRECREATION

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.

iv_path TYPE /AWS1/FRMRESOURCEPROPERTYPATH /AWS1/FRMRESOURCEPROPERTYPATH

The property path of the property.

iv_beforevalue TYPE /AWS1/FRMBEFOREVALUE /AWS1/FRMBEFOREVALUE

The value of the property before the change is executed. Large values can be truncated.

iv_aftervalue TYPE /AWS1/FRMAFTERVALUE /AWS1/FRMAFTERVALUE

The value of the property after the change is executed. Large values can be truncated.

iv_beforevaluefrom TYPE /AWS1/FRMBEFOREVALUEFROM /AWS1/FRMBEFOREVALUEFROM

Indicates the source of the before value. Valid values:

  • ACTUAL_STATE – The before value represents current actual state.

  • PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

Only present for drift-aware change sets.

iv_aftervaluefrom TYPE /AWS1/FRMAFTERVALUEFROM /AWS1/FRMAFTERVALUEFROM

Indicates the source of the after value. Valid value:

  • TEMPLATE – The after value comes from the new template.

Only present for drift-aware change sets.

io_drift TYPE REF TO /AWS1/CL_FRMLIVERESOURCEDRIFT /AWS1/CL_FRMLIVERESOURCEDRIFT

Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.

iv_attributechangetype TYPE /AWS1/FRMATTRIBUTECHANGETYPE /AWS1/FRMATTRIBUTECHANGETYPE

The type of change to be made to the property if the change is executed.

  • Add The item will be added.

  • Remove The item will be removed.

  • Modify The item will be modified.

  • SyncWithActual The drift status of this item will be reset but the item will not be modified.

Queryable Attributes

Attribute

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_ATTRIBUTE() Getter for ATTRIBUTE, with configurable default
ASK_ATTRIBUTE() Getter for ATTRIBUTE w/ exceptions if field has no value
HAS_ATTRIBUTE() Determine if ATTRIBUTE has a value

Name

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

RequiresRecreation

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Accessible with the following methods

Method Description
GET_REQUIRESRECREATION() Getter for REQUIRESRECREATION, with configurable default
ASK_REQUIRESRECREATION() Getter for REQUIRESRECREATION w/ exceptions if field has no
HAS_REQUIRESRECREATION() Determine if REQUIRESRECREATION has a value

Path

The property path of the property.

Accessible with the following methods

Method Description
GET_PATH() Getter for PATH, with configurable default
ASK_PATH() Getter for PATH w/ exceptions if field has no value
HAS_PATH() Determine if PATH has a value

BeforeValue

The value of the property before the change is executed. Large values can be truncated.

Accessible with the following methods

Method Description
GET_BEFOREVALUE() Getter for BEFOREVALUE, with configurable default
ASK_BEFOREVALUE() Getter for BEFOREVALUE w/ exceptions if field has no value
HAS_BEFOREVALUE() Determine if BEFOREVALUE has a value

AfterValue

The value of the property after the change is executed. Large values can be truncated.

Accessible with the following methods

Method Description
GET_AFTERVALUE() Getter for AFTERVALUE, with configurable default
ASK_AFTERVALUE() Getter for AFTERVALUE w/ exceptions if field has no value
HAS_AFTERVALUE() Determine if AFTERVALUE has a value

BeforeValueFrom

Indicates the source of the before value. Valid values:

  • ACTUAL_STATE – The before value represents current actual state.

  • PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

Only present for drift-aware change sets.

Accessible with the following methods

Method Description
GET_BEFOREVALUEFROM() Getter for BEFOREVALUEFROM, with configurable default
ASK_BEFOREVALUEFROM() Getter for BEFOREVALUEFROM w/ exceptions if field has no val
HAS_BEFOREVALUEFROM() Determine if BEFOREVALUEFROM has a value

AfterValueFrom

Indicates the source of the after value. Valid value:

  • TEMPLATE – The after value comes from the new template.

Only present for drift-aware change sets.

Accessible with the following methods

Method Description
GET_AFTERVALUEFROM() Getter for AFTERVALUEFROM, with configurable default
ASK_AFTERVALUEFROM() Getter for AFTERVALUEFROM w/ exceptions if field has no valu
HAS_AFTERVALUEFROM() Determine if AFTERVALUEFROM has a value

Drift

Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.

Accessible with the following methods

Method Description
GET_DRIFT() Getter for DRIFT

AttributeChangeType

The type of change to be made to the property if the change is executed.

  • Add The item will be added.

  • Remove The item will be removed.

  • Modify The item will be modified.

  • SyncWithActual The drift status of this item will be reset but the item will not be modified.

Accessible with the following methods

Method Description
GET_ATTRIBUTECHANGETYPE() Getter for ATTRIBUTECHANGETYPE, with configurable default
ASK_ATTRIBUTECHANGETYPE() Getter for ATTRIBUTECHANGETYPE w/ exceptions if field has no
HAS_ATTRIBUTECHANGETYPE() Determine if ATTRIBUTECHANGETYPE has a value