/AWS1/CL_FRMDSCSTACKDRIFTDET01¶
DescribeStackDriftDetectionStatusOutput
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
IV_STACKID
TYPE /AWS1/FRMSTACKID
/AWS1/FRMSTACKID
¶
The ID of the stack.
IV_STACKDRIFTDETECTIONID
TYPE /AWS1/FRMSTACKDRIFTDETECTIONID
/AWS1/FRMSTACKDRIFTDETECTIONID
¶
The ID of the drift detection results of this operation.
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.
IV_DETECTIONSTATUS
TYPE /AWS1/FRMSTACKDRIFTDETECTSTAT
/AWS1/FRMSTACKDRIFTDETECTSTAT
¶
The status of the stack drift detection operation.
DETECTION_COMPLETE
: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
DETECTION_FAILED
: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
DETECTION_IN_PROGRESS
: The stack drift detection operation is currently in progress.
IV_TIMESTAMP
TYPE /AWS1/FRMTIMESTAMP
/AWS1/FRMTIMESTAMP
¶
Time at which the stack drift detection operation was initiated.
Optional arguments:¶
IV_STACKDRIFTSTATUS
TYPE /AWS1/FRMSTACKDRIFTSTATUS
/AWS1/FRMSTACKDRIFTSTATUS
¶
Status of the stack's actual configuration compared to its expected configuration.
DRIFTED
: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
NOT_CHECKED
: CloudFormation hasn't checked if the stack differs from its expected template configuration.
IN_SYNC
: The stack's actual configuration matches its expected template configuration.
UNKNOWN
: This value is reserved for future use.
IV_DETECTIONSTATUSREASON
TYPE /AWS1/FRMSTACKDRIFTDETSTATRSN
/AWS1/FRMSTACKDRIFTDETSTATRSN
¶
The reason the stack drift detection operation has its current status.
IV_DRIFTEDSTACKRESOURCECOUNT
TYPE /AWS1/FRMBOXEDINTEGER
/AWS1/FRMBOXEDINTEGER
¶
Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of
DETECTION_COMPLETE
. This value will be 0 for stacks whose drift status isIN_SYNC
.
Queryable Attributes¶
StackId¶
The ID of the stack.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STACKID() |
Getter for STACKID, with configurable default |
ASK_STACKID() |
Getter for STACKID w/ exceptions if field has no value |
HAS_STACKID() |
Determine if STACKID has a value |
StackDriftDetectionId¶
The ID of the drift detection results of this operation.
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STACKDRIFTDETECTIONID() |
Getter for STACKDRIFTDETECTIONID, with configurable default |
ASK_STACKDRIFTDETECTIONID() |
Getter for STACKDRIFTDETECTIONID w/ exceptions if field has |
HAS_STACKDRIFTDETECTIONID() |
Determine if STACKDRIFTDETECTIONID has a value |
StackDriftStatus¶
Status of the stack's actual configuration compared to its expected configuration.
DRIFTED
: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
NOT_CHECKED
: CloudFormation hasn't checked if the stack differs from its expected template configuration.
IN_SYNC
: The stack's actual configuration matches its expected template configuration.
UNKNOWN
: This value is reserved for future use.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STACKDRIFTSTATUS() |
Getter for STACKDRIFTSTATUS, with configurable default |
ASK_STACKDRIFTSTATUS() |
Getter for STACKDRIFTSTATUS w/ exceptions if field has no va |
HAS_STACKDRIFTSTATUS() |
Determine if STACKDRIFTSTATUS has a value |
DetectionStatus¶
The status of the stack drift detection operation.
DETECTION_COMPLETE
: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
DETECTION_FAILED
: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
DETECTION_IN_PROGRESS
: The stack drift detection operation is currently in progress.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DETECTIONSTATUS() |
Getter for DETECTIONSTATUS, with configurable default |
ASK_DETECTIONSTATUS() |
Getter for DETECTIONSTATUS w/ exceptions if field has no val |
HAS_DETECTIONSTATUS() |
Determine if DETECTIONSTATUS has a value |
DetectionStatusReason¶
The reason the stack drift detection operation has its current status.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DETECTIONSTATUSREASON() |
Getter for DETECTIONSTATUSREASON, with configurable default |
ASK_DETECTIONSTATUSREASON() |
Getter for DETECTIONSTATUSREASON w/ exceptions if field has |
HAS_DETECTIONSTATUSREASON() |
Determine if DETECTIONSTATUSREASON has a value |
DriftedStackResourceCount¶
Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of
DETECTION_COMPLETE
. This value will be 0 for stacks whose drift status isIN_SYNC
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DRIFTEDSTACKRESRCCOUNT() |
Getter for DRIFTEDSTACKRESOURCECOUNT, with configurable defa |
ASK_DRIFTEDSTACKRESRCCOUNT() |
Getter for DRIFTEDSTACKRESOURCECOUNT w/ exceptions if field |
HAS_DRIFTEDSTACKRESRCCOUNT() |
Determine if DRIFTEDSTACKRESOURCECOUNT has a value |
Timestamp¶
Time at which the stack drift detection operation was initiated.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TIMESTAMP() |
Getter for TIMESTAMP, with configurable default |
ASK_TIMESTAMP() |
Getter for TIMESTAMP w/ exceptions if field has no value |
HAS_TIMESTAMP() |
Determine if TIMESTAMP has a value |