CloudFormation / Client / detect_stack_resource_drift

detect_stack_resource_drift#

CloudFormation.Client.detect_stack_resource_drift(**kwargs)#

Returns information about whether a resource’s actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

Resources that don’t currently support drift detection can’t be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.

See also: AWS API Documentation

Request Syntax

response = client.detect_stack_resource_drift(
    StackName='string',
    LogicalResourceId='string'
)
Parameters:

  • StackName (string) –

    [REQUIRED]

    The name of the stack to which the resource belongs.

  • LogicalResourceId (string) –

    [REQUIRED]

    The logical name of the resource for which to return drift information.

Return type:

dict

Returns:

Response Syntax

{
    'StackResourceDrift': {
        'StackId': 'string',
        'LogicalResourceId': 'string',
        'PhysicalResourceId': 'string',
        'PhysicalResourceIdContext': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ResourceType': 'string',
        'ExpectedProperties': 'string',
        'ActualProperties': 'string',
        'PropertyDifferences': [
            {
                'PropertyPath': 'string',
                'ExpectedValue': 'string',
                'ActualValue': 'string',
                'DifferenceType': 'ADD'|'REMOVE'|'NOT_EQUAL'
            },
        ],
        'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
        'Timestamp': datetime(2015, 1, 1),
        'ModuleInfo': {
            'TypeHierarchy': 'string',
            'LogicalIdHierarchy': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • StackResourceDrift (dict) –

      Information about whether the resource’s actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

      • StackId (string) –

        The ID of the stack.

      • LogicalResourceId (string) –

        The logical name of the resource specified in the template.

      • PhysicalResourceId (string) –

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

      • PhysicalResourceIdContext (list) –

        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.

        • (dict) –

          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 resource that contains the targeted resource.

          • Key (string) –

            The resource context key.

          • Value (string) –

            The resource context value.

      • ResourceType (string) –

        The type of the resource.

      • ExpectedProperties (string) –

        A JSON structure containing 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.

      • ActualProperties (string) –

        A JSON structure containing the actual property values of the stack resource.

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

      • PropertyDifferences (list) –

        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.

        • (dict) –

          Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

          • PropertyPath (string) –

            The fully-qualified path to the resource property.

          • ExpectedValue (string) –

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

          • ActualValue (string) –

            The actual property value of the resource property.

          • DifferenceType (string) –

            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).

      • StackResourceDriftStatus (string) –

        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.

      • Timestamp (datetime) –

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

      • ModuleInfo (dict) –

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

        • TypeHierarchy (string) –

          A concatenated list of the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

          In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that’s nested inside a parent module of type AWS::Second::Example::MODULE.

          AWS::First::Example::MODULE/AWS::Second::Example::MODULE

        • LogicalIdHierarchy (string) –

          A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

          In the following example, the resource was created from a module, moduleA, that’s nested inside a parent module, moduleB.

          moduleA/moduleB

          For more information, see Referencing resources in a module in the CloudFormation User Guide.