Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS CloudFormation Stack Drift API

Operations for detecting and describing configuration drift.

AWS CloudFormation Stack Drift API is one of 13 APIs that AWS CloudFormation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Stack Drift. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a getting-started guide, and a changelog.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2021-09-30.

Requests are made against a single base URL, https://cloudcontrolapi.{region}.amazonaws.com.

4 operations 4 paths 3 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2021-09-30
Base URL
https://cloudformation.{region}.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

AWS CloudFormation Stack Drift API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (AWS_Signature_V4). By default, every request must be authenticated.

  • AWS_Signature_V4 — AWS Signature Version 4 authentication.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Stack Drift 4

Operations for detecting and describing configuration drift.

POST
/?Action=DetectStackDrift
Detect Configuration Drift on a Stack
detectStackDrift 1 param body → 200400404500
POST
/?Action=DescribeStackDriftDetectionStatus
Check Status of Drift Detection
describeStackDriftDetectionStatus 1 param body → 200400500
POST
/?Action=DescribeStackResourceDrifts
Get Drift Information for Stack Resources
describeStackResourceDrifts 1 param body → 200400500
POST
/?Action=DetectStackResourceDrift
Detect Drift on a Specific Resource
detectStackResourceDrift 1 param body → 200400404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are StackResourceDrift (10 properties), PropertyDifference (4 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

PropertyDifference
object
4 properties 4 required
ErrorResponse
object
2 properties
StackResourceDrift
object
10 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudformation-stack-drift-api-openapi.yml Raw ↑

Other APIs AWS CloudFormation publishes across the network.

AWS CloudFormation Change Sets API
AWS CloudFormation Exports API
AWS CloudFormation Registry API
AWS CloudFormation Request Status API
AWS CloudFormation Resources API
AWS CloudFormation Stack Events API
AWS CloudFormation Stack Instances API
AWS CloudFormation Stack Policies API
AWS CloudFormation Stack Resources API
AWS CloudFormation Stack Sets API
AWS CloudFormation Stacks API
AWS CloudFormation Templates API