cloudformation_describe_stack_drift_detection_status: Returns information about a stack drift detection operation

Description Usage Arguments Value Request syntax

View source: R/cloudformation_operations.R

Description

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use detect_stack_drift to initiate a stack drift detection operation. detect_stack_drift returns a StackDriftDetectionId you can use to monitor the progress of the operation using describe_stack_drift_detection_status. Once the drift detection operation has completed, use describe_stack_resource_drifts to return drift information about the stack and its resources.

Usage

1
2

Arguments

StackDriftDetectionId

[required] The ID of the drift detection results of this operation.

AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
list(
  StackId = "string",
  StackDriftDetectionId = "string",
  StackDriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED",
  DetectionStatus = "DETECTION_IN_PROGRESS"|"DETECTION_FAILED"|"DETECTION_COMPLETE",
  DetectionStatusReason = "string",
  DriftedStackResourceCount = 123,
  Timestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

1
2
3
svc$describe_stack_drift_detection_status(
  StackDriftDetectionId = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.