AWS CloudFormation

2025/06/30 - AWS CloudFormation - 6 updated api methods

Changes  Added support for UNKNOWN drift status.

DescribeStackResource (updated) Link ¶
Changes (response)
{'StackResourceDetail': {'DriftInformation': {'StackResourceDriftStatus': {'UNKNOWN'}}}}

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

See also: AWS API Documentation

Request Syntax

client.describe_stack_resource(
    StackName='string',
    LogicalResourceId='string'
)
type StackName:

string

param StackName:

[REQUIRED]

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

type LogicalResourceId:

string

param LogicalResourceId:

[REQUIRED]

The logical name of the resource as specified in the template.

rtype:

dict

returns:

Response Syntax

{
    'StackResourceDetail': {
        'StackName': 'string',
        'StackId': 'string',
        'LogicalResourceId': 'string',
        'PhysicalResourceId': 'string',
        'ResourceType': 'string',
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE'|'IMPORT_FAILED'|'IMPORT_COMPLETE'|'IMPORT_IN_PROGRESS'|'IMPORT_ROLLBACK_IN_PROGRESS'|'IMPORT_ROLLBACK_FAILED'|'IMPORT_ROLLBACK_COMPLETE'|'EXPORT_FAILED'|'EXPORT_COMPLETE'|'EXPORT_IN_PROGRESS'|'EXPORT_ROLLBACK_IN_PROGRESS'|'EXPORT_ROLLBACK_FAILED'|'EXPORT_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
        'ResourceStatusReason': 'string',
        'Description': 'string',
        'Metadata': 'string',
        'DriftInformation': {
            'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED'|'UNKNOWN',
            'LastCheckTimestamp': datetime(2015, 1, 1)
        },
        'ModuleInfo': {
            'TypeHierarchy': 'string',
            'LogicalIdHierarchy': 'string'
        }
    }
}

Response Structure

  • (dict) --

    The output for a DescribeStackResource action.

    • StackResourceDetail (dict) --

      A StackResourceDetail structure that contains the description of the specified resource in the specified stack.

      • StackName (string) --

        The name associated with the stack.

      • StackId (string) --

        Unique identifier 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.

      • ResourceType (string) --

        Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

      • LastUpdatedTimestamp (datetime) --

        Time the status was updated.

      • ResourceStatus (string) --

        Current status of the resource.

      • ResourceStatusReason (string) --

        Success/failure message associated with the resource.

      • Description (string) --

        User defined description associated with the resource.

      • Metadata (string) --

        The content of the Metadata attribute declared for the resource. For more information, see Metadata attribute in the CloudFormation User Guide.

      • DriftInformation (dict) --

        Information about whether the 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. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

        • StackResourceDriftStatus (string) --

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

          • DELETED: The resource differs from its expected configuration in that it has been deleted.

          • MODIFIED: The resource differs from its expected configuration.

          • NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection.

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

        • LastCheckTimestamp (datetime) --

          When CloudFormation last checked if the resource had drifted from its expected configuration.

      • 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 that contains 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 that contains 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 Reference module resources in CloudFormation templates in the CloudFormation User Guide.

DescribeStackResourceDrifts (updated) Link ¶
Changes (request, response)
Request
{'StackResourceDriftStatusFilters': {'UNKNOWN'}}
Response
{'StackResourceDrifts': {'DriftStatusReason': 'string',
                         'StackResourceDriftStatus': {'UNKNOWN'}}}

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.

See also: AWS API Documentation

Request Syntax

client.describe_stack_resource_drifts(
    StackName='string',
    StackResourceDriftStatusFilters=[
        'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED'|'UNKNOWN',
    ],
    NextToken='string',
    MaxResults=123
)
type StackName:

string

param StackName:

[REQUIRED]

The name of the stack for which you want drift information.

type StackResourceDriftStatusFilters:

list

param StackResourceDriftStatusFilters:

The resource drift status values to use as filters for the resource drift results returned.

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

  • MODIFIED: One or more resource properties differ from their expected template values.

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

  • NOT_CHECKED: CloudFormation doesn't currently return this value.

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

  • (string) --

type NextToken:

string

param NextToken:

A string that identifies the next page of stack resource drift results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'StackResourceDrifts': [
        {
            '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'|'UNKNOWN',
            'Timestamp': datetime(2015, 1, 1),
            'ModuleInfo': {
                'TypeHierarchy': 'string',
                'LogicalIdHierarchy': 'string'
            },
            'DriftStatusReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • StackResourceDrifts (list) --

      Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

      For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

      • (dict) --

        Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

        Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

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

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

        • ActualProperties (string) --

          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.

        • 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 Detect unmanaged configuration changes to stacks and resources with drift detection.

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

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

        • 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 that contains 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 that contains 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 Reference module resources in CloudFormation templates in the CloudFormation User Guide.

        • DriftStatusReason (string) --

          The reason for the drift status.

    • NextToken (string) --

      If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

DescribeStackResources (updated) Link ¶
Changes (response)
{'StackResources': {'DriftInformation': {'StackResourceDriftStatus': {'UNKNOWN'}}}}

Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, see the CloudFormation User Guide.

See also: AWS API Documentation

Request Syntax

client.describe_stack_resources(
    StackName='string',
    LogicalResourceId='string',
    PhysicalResourceId='string'
)
type StackName:

string

param StackName:

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Required: Conditional. If you don't specify StackName, you must specify PhysicalResourceId.

type LogicalResourceId:

string

param LogicalResourceId:

The logical name of the resource as specified in the template.

type PhysicalResourceId:

string

param PhysicalResourceId:

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

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you don't specify PhysicalResourceId, you must specify StackName.

rtype:

dict

returns:

Response Syntax

{
    'StackResources': [
        {
            'StackName': 'string',
            'StackId': 'string',
            'LogicalResourceId': 'string',
            'PhysicalResourceId': 'string',
            'ResourceType': 'string',
            'Timestamp': datetime(2015, 1, 1),
            'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE'|'IMPORT_FAILED'|'IMPORT_COMPLETE'|'IMPORT_IN_PROGRESS'|'IMPORT_ROLLBACK_IN_PROGRESS'|'IMPORT_ROLLBACK_FAILED'|'IMPORT_ROLLBACK_COMPLETE'|'EXPORT_FAILED'|'EXPORT_COMPLETE'|'EXPORT_IN_PROGRESS'|'EXPORT_ROLLBACK_IN_PROGRESS'|'EXPORT_ROLLBACK_FAILED'|'EXPORT_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
            'ResourceStatusReason': 'string',
            'Description': 'string',
            'DriftInformation': {
                'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED'|'UNKNOWN',
                'LastCheckTimestamp': datetime(2015, 1, 1)
            },
            'ModuleInfo': {
                'TypeHierarchy': 'string',
                'LogicalIdHierarchy': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    The output for a DescribeStackResources action.

    • StackResources (list) --

      A list of StackResource structures.

      • (dict) --

        The StackResource data type.

        • StackName (string) --

          The name associated with the stack.

        • StackId (string) --

          Unique identifier 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.

        • ResourceType (string) --

          Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

        • Timestamp (datetime) --

          Time the status was updated.

        • ResourceStatus (string) --

          Current status of the resource.

        • ResourceStatusReason (string) --

          Success/failure message associated with the resource.

        • Description (string) --

          User defined description associated with the resource.

        • DriftInformation (dict) --

          Information about whether the 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. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

          • StackResourceDriftStatus (string) --

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

            • DELETED: The resource differs from its expected configuration in that it has been deleted.

            • MODIFIED: The resource differs from its expected configuration.

            • NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection.

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

          • LastCheckTimestamp (datetime) --

            When CloudFormation last checked if the resource had drifted from its expected configuration.

        • 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 that contains 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 that contains 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 Reference module resources in CloudFormation templates in the CloudFormation User Guide.

DetectStackResourceDrift (updated) Link ¶
Changes (response)
{'StackResourceDrift': {'DriftStatusReason': 'string',
                        'StackResourceDriftStatus': {'UNKNOWN'}}}

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 Detect unmanaged configuration changes to stacks and resources with drift detection.

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 Resource type support for imports and drift detection.

See also: AWS API Documentation

Request Syntax

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

string

param StackName:

[REQUIRED]

The name of the stack to which the resource belongs.

type LogicalResourceId:

string

param LogicalResourceId:

[REQUIRED]

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

rtype:

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'|'UNKNOWN',
        'Timestamp': datetime(2015, 1, 1),
        'ModuleInfo': {
            'TypeHierarchy': 'string',
            'LogicalIdHierarchy': 'string'
        },
        'DriftStatusReason': '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 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.

      • ActualProperties (string) --

        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.

      • 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 Detect unmanaged configuration changes to stacks and resources with drift detection.

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

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

      • 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 that contains 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 that contains 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 Reference module resources in CloudFormation templates in the CloudFormation User Guide.

      • DriftStatusReason (string) --

        The reason for the drift status.

ListStackInstanceResourceDrifts (updated) Link ¶
Changes (request, response)
Request
{'StackInstanceResourceDriftStatuses': {'UNKNOWN'}}
Response
{'Summaries': {'StackResourceDriftStatus': {'UNKNOWN'}}}

Returns drift information for resources in a stack instance.

See also: AWS API Documentation

Request Syntax

client.list_stack_instance_resource_drifts(
    StackSetName='string',
    NextToken='string',
    MaxResults=123,
    StackInstanceResourceDriftStatuses=[
        'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED'|'UNKNOWN',
    ],
    StackInstanceAccount='string',
    StackInstanceRegion='string',
    OperationId='string',
    CallAs='SELF'|'DELEGATED_ADMIN'
)
type StackSetName:

string

param StackSetName:

[REQUIRED]

The name or unique ID of the stack set that you want to list drifted resources for.

type NextToken:

string

param NextToken:

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

type MaxResults:

integer

param MaxResults:

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

type StackInstanceResourceDriftStatuses:

list

param StackInstanceResourceDriftStatuses:

The resource drift status of the stack instance.

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

  • MODIFIED: One or more resource properties differ from their expected template values.

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

  • NOT_CHECKED: CloudFormation doesn't currently return this value.

  • (string) --

type StackInstanceAccount:

string

param StackInstanceAccount:

[REQUIRED]

The name of the Amazon Web Services account that you want to list resource drifts for.

type StackInstanceRegion:

string

param StackInstanceRegion:

[REQUIRED]

The name of the Region where you want to list resource drifts.

type OperationId:

string

param OperationId:

[REQUIRED]

The unique ID of the drift operation.

type CallAs:

string

param CallAs:

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

rtype:

dict

returns:

Response Syntax

{
    'Summaries': [
        {
            'StackId': 'string',
            'LogicalResourceId': 'string',
            'PhysicalResourceId': 'string',
            'PhysicalResourceIdContext': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ResourceType': 'string',
            'PropertyDifferences': [
                {
                    'PropertyPath': 'string',
                    'ExpectedValue': 'string',
                    'ActualValue': 'string',
                    'DifferenceType': 'ADD'|'REMOVE'|'NOT_EQUAL'
                },
            ],
            'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED'|'UNKNOWN',
            'Timestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Summaries (list) --

      A list of StackInstanceResourceDriftsSummary structures that contain information about the specified stack instances.

      • (dict) --

        The structure containing summary information about resource drifts for a stack instance.

        • StackId (string) --

          The ID of the stack instance.

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

          Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

        • PropertyDifferences (list) --

          Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose StackInstanceResourceDriftStatus 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 Detect unmanaged configuration changes to stacks and resources with drift detection.

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

          The drift status of the resource in a stack instance.

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

          • MODIFIED: One or more resource properties differ from their expected template values.

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

          • NOT_CHECKED: CloudFormation doesn't currently return this value.

        • Timestamp (datetime) --

          Time at which the stack instance drift detection operation was initiated.

    • NextToken (string) --

      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

ListStackResources (updated) Link ¶
Changes (response)
{'StackResourceSummaries': {'DriftInformation': {'StackResourceDriftStatus': {'UNKNOWN'}}}}

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

See also: AWS API Documentation

Request Syntax

client.list_stack_resources(
    StackName='string',
    NextToken='string'
)
type StackName:

string

param StackName:

[REQUIRED]

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

type NextToken:

string

param NextToken:

A string that identifies the next page of stack resources that you want to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'StackResourceSummaries': [
        {
            'LogicalResourceId': 'string',
            'PhysicalResourceId': 'string',
            'ResourceType': 'string',
            'LastUpdatedTimestamp': datetime(2015, 1, 1),
            'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE'|'IMPORT_FAILED'|'IMPORT_COMPLETE'|'IMPORT_IN_PROGRESS'|'IMPORT_ROLLBACK_IN_PROGRESS'|'IMPORT_ROLLBACK_FAILED'|'IMPORT_ROLLBACK_COMPLETE'|'EXPORT_FAILED'|'EXPORT_COMPLETE'|'EXPORT_IN_PROGRESS'|'EXPORT_ROLLBACK_IN_PROGRESS'|'EXPORT_ROLLBACK_FAILED'|'EXPORT_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE'|'UPDATE_ROLLBACK_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
            'ResourceStatusReason': 'string',
            'DriftInformation': {
                'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED'|'UNKNOWN',
                'LastCheckTimestamp': datetime(2015, 1, 1)
            },
            'ModuleInfo': {
                'TypeHierarchy': 'string',
                'LogicalIdHierarchy': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The output for a ListStackResources action.

    • StackResourceSummaries (list) --

      A list of StackResourceSummary structures.

      • (dict) --

        Contains high-level information about the specified stack resource.

        • 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 the resource.

        • ResourceType (string) --

          Type of resource. (For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.)

        • LastUpdatedTimestamp (datetime) --

          Time the status was updated.

        • ResourceStatus (string) --

          Current status of the resource.

        • ResourceStatusReason (string) --

          Success/failure message associated with the resource.

        • DriftInformation (dict) --

          Information about whether the 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. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

          • StackResourceDriftStatus (string) --

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

            • DELETED: The resource differs from its expected configuration in that it has been deleted.

            • MODIFIED: The resource differs from its expected configuration.

            • NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration. Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information about skipping resources during rollback operations, see Continue rolling back an update in the CloudFormation User Guide.

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

          • LastCheckTimestamp (datetime) --

            When CloudFormation last checked if the resource had drifted from its expected configuration.

        • 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 that contains 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 that contains 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 Reference module resources in CloudFormation templates in the CloudFormation User Guide.

    • NextToken (string) --

      If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.