CloudFormation / Client / describe_stack_resources

describe_stack_resources#

CloudFormation.Client.describe_stack_resources(**kwargs)#

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.

Note

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

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, go to the CloudFormation User Guide.

Note

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

See also: AWS API Documentation

Request Syntax

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

  • StackName (string) –

    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.

    Default: There is no default value.

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

  • LogicalResourceId (string) –

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

    Default: There is no default value.

  • PhysicalResourceId (string) –

    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.

    Default: There is no default value.

Return type:

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'|'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',
                '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, go to Amazon Web Services Resource 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 Detecting Unregulated Configuration Changes to Stacks and Resources.

          • 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 Resources that Support 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 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.