CloudFormation / Client / list_stack_instance_resource_drifts

list_stack_instance_resource_drifts#

CloudFormation.Client.list_stack_instance_resource_drifts(**kwargs)#

Returns drift information for resources in a stack instance.

Note

ListStackInstanceResourceDrifts returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.

See also: AWS API Documentation

Request Syntax

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

  • StackSetName (string) –

    [REQUIRED]

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

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

  • MaxResults (integer) – 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.

  • StackInstanceResourceDriftStatuses (list) –

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

  • StackInstanceAccount (string) –

    [REQUIRED]

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

  • StackInstanceRegion (string) –

    [REQUIRED]

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

  • OperationId (string) –

    [REQUIRED]

    The unique ID of the drift operation.

  • CallAs (string) –

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

Return type:

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',
            '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, go to Amazon Web Services Resource 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 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) –

          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.

Exceptions

  • CloudFormation.Client.exceptions.StackSetNotFoundException

  • CloudFormation.Client.exceptions.StackInstanceNotFoundException

  • CloudFormation.Client.exceptions.OperationNotFoundException