Skip to content

StackResourceDrift

Source code in docs_src/capo_cloudformation/types/stack_resource_drift.py
class StackResourceDrift(TypedDict, closed=True):
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>The ID of the stack.</p>"""
    logical_resource_id: NotRequired[
        "capo_cloudformation.types.logical_resource_id.LogicalResourceId"
    ]
    """<p>The logical name of the resource specified in the template.</p>"""
    physical_resource_id: NotRequired[
        "capo_cloudformation.types.physical_resource_id.PhysicalResourceId"
    ]
    """<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>"""
    physical_resource_id_context: NotRequired[
        "capo_cloudformation.types.physical_resource_id_context.PhysicalResourceIdContext"
    ]
    """<p>Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.</p>"""
    resource_type: NotRequired["capo_cloudformation.types.resource_type.ResourceType"]
    """<p>The type of the resource.</p>"""
    expected_properties: NotRequired["capo_cloudformation.types.properties.Properties"]
    """<p>A JSON structure that contains the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.</p> <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this structure will not be present.</p>"""
    actual_properties: NotRequired["capo_cloudformation.types.properties.Properties"]
    """<p>A JSON structure that contains the actual property values of the stack resource.</p> <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this structure will not be present.</p>"""
    property_differences: NotRequired[
        "capo_cloudformation.types.property_differences.PropertyDifferences"
    ]
    """<p>A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose <code>StackResourceDriftStatus</code> is <code>MODIFIED</code>.</p>"""
    stack_resource_drift_status: NotRequired[
        "capo_cloudformation.types.stack_resource_drift_status.StackResourceDriftStatus"
    ]
    """<p>Status of the resource's actual configuration compared to its expected configuration.</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected template configuration because the resource has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).</p> </li> <li> <p> <code>IN_SYNC</code>: The resource's actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation does not currently return this value.</p> </li> <li> <p> <code>UNKNOWN</code>: CloudFormation could not run drift detection for the resource. See the <code>DriftStatusReason</code> for details.</p> </li> </ul>"""
    timestamp: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>Time at which CloudFormation performed drift detection on the stack resource.</p>"""
    module_info: NotRequired["capo_cloudformation.types.module_info.ModuleInfo"]
    """<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p>"""
    drift_status_reason: NotRequired[
        "capo_cloudformation.types.stack_resource_drift_status_reason.StackResourceDriftStatusReason"
    ]
    """<p>The reason for the drift status. </p>"""

actual_properties instance-attribute

actual_properties: NotRequired[Properties]

A JSON structure that contains the actual property values of the stack resource.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

drift_status_reason instance-attribute

drift_status_reason: NotRequired[StackResourceDriftStatusReason]

The reason for the drift status.

expected_properties instance-attribute

expected_properties: NotRequired[Properties]

A JSON structure that contains the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

logical_resource_id instance-attribute

logical_resource_id: NotRequired[LogicalResourceId]

The logical name of the resource specified in the template.

module_info instance-attribute

module_info: NotRequired[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.

physical_resource_id instance-attribute

physical_resource_id: NotRequired[PhysicalResourceId]

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

physical_resource_id_context instance-attribute

physical_resource_id_context: NotRequired[PhysicalResourceIdContext]

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

property_differences instance-attribute

property_differences: NotRequired[PropertyDifferences]

A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The type of the resource.

stack_id instance-attribute

stack_id: NotRequired[StackId]

The ID of the stack.

stack_resource_drift_status instance-attribute

stack_resource_drift_status: NotRequired[StackResourceDriftStatus]

Status of the resource's actual configuration compared to its expected configuration.

  • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

  • IN_SYNC: The resource's actual configuration matches its expected template configuration.

  • NOT_CHECKED: CloudFormation does not currently return this value.

  • UNKNOWN: CloudFormation could not run drift detection for the resource. See the DriftStatusReason for details.

timestamp instance-attribute

timestamp: NotRequired[Timestamp]

Time at which CloudFormation performed drift detection on the stack resource.