AWS CloudFormation
API Reference (API Version 2010-05-15)

StackResourceDrift

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support 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.

Contents

ActualProperties

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

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

Type: String

Required: No

ExpectedProperties

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.

Type: String

Required: No

LogicalResourceId

The logical name of the resource specified in the template.

Type: String

Required: Yes

PhysicalResourceId

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

Type: String

Required: No

PhysicalResourceIdContext.member.N

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

Type: Array of PhysicalResourceIdContextKeyValuePair objects

Array Members: Maximum number of 5 items.

Required: No

PropertyDifferences.member.N

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.

Type: Array of PropertyDifference objects

Required: No

ResourceType

The type of the resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

StackId

The ID of the stack.

Type: String

Required: Yes

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 resources's actual configuration matches its expected template configuration.

  • NOT_CHECKED: AWS CloudFormation does not currently return this value.

Type: String

Valid Values: IN_SYNC | MODIFIED | DELETED | NOT_CHECKED

Required: Yes

Timestamp

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

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: