Skip to content

PropertyDifference

Source code in docs_src/capo_cloudformation/types/property_difference.py
class PropertyDifference(TypedDict, closed=True):
    property_path: NotRequired["capo_cloudformation.types.property_path.PropertyPath"]
    """<p>The fully-qualified path to the resource property.</p>"""
    expected_value: NotRequired[
        "capo_cloudformation.types.property_value.PropertyValue"
    ]
    """<p>The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.</p>"""
    actual_value: NotRequired["capo_cloudformation.types.property_value.PropertyValue"]
    """<p>The actual property value of the resource property.</p>"""
    difference_type: NotRequired[
        "capo_cloudformation.types.difference_type.DifferenceType"
    ]
    """<p>The type of property difference.</p> <ul> <li> <p> <code>ADD</code>: A value has been added to a resource property that's an array or list data type.</p> </li> <li> <p> <code>REMOVE</code>: The property has been removed from the current resource configuration.</p> </li> <li> <p> <code>NOT_EQUAL</code>: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).</p> </li> </ul>"""

actual_value instance-attribute

actual_value: NotRequired[PropertyValue]

The actual property value of the resource property.

difference_type instance-attribute

difference_type: NotRequired[DifferenceType]

The type of property difference.

  • ADD: A value has been added to a resource property that's an array or list data type.

  • REMOVE: The property has been removed from the current resource configuration.

  • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

expected_value instance-attribute

expected_value: NotRequired[PropertyValue]

The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

property_path instance-attribute

property_path: NotRequired[PropertyPath]

The fully-qualified path to the resource property.