DetectStackSetDrift - AWS CloudFormation

DetectStackSetDrift

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set.

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

  • Use DescribeStackSet to return detailed informaiton about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.)

  • Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.

  • Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.

For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets.

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation .

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

OperationId

The ID of the stack set operation.

Type: String

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

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

OperationPreferences

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.

Type: StackSetOperationPreferences object

Required: No

StackSetName

The name of the stack set on which to perform the drift detection operation.

Type: String

Pattern: [a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?

Required: Yes

Response Elements

The following element is returned by the service.

OperationId

The ID of the drift detection stack set operation.

you can use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation.

Type: String

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

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidOperation

The specified operation isn't valid.

HTTP Status Code: 400

OperationInProgress

Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

HTTP Status Code: 409

StackSetNotFound

The specified stack set doesn't exist.

HTTP Status Code: 404

Example

DetectStackSetDrift

Sample Request

https://cloudformation.us-east-1.amazonaws.com/ ?Action=DetectStackSetDrift &Version=2010-05-15 &StackSetName=stack-set-example &OperationId=9cc082fa-df4c-45cd-b9a8-7e56example &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=[Access key ID and scope] &X-Amz-Date=20191203T195756Z &X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]

Sample Response

<DetectStackSetDriftResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/"> <DetectStackSetDriftResult> <OperationId>9cc082fa-df4c-45cd-b9a8-7e56example</OperationId> </DetectStackSetDriftResult> <ResponseMetadata> <RequestId>38309f0a-d5f5-4330-b6ca-8eb1example</RequestId> </ResponseMetadata> </DetectStackSetDriftResponse>

See Also

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