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 Stacks API

Operations for creating, updating, deleting, and describing CloudFormation stacks.

AWS CloudFormation Stacks 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 Stacks. 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 9 operations across 9 paths, and defines 10 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.

9 operations 9 paths 10 schemas 9 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 Stacks 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 9

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

Stacks 9

Operations for creating, updating, deleting, and describing CloudFormation stacks.

POST
/?Action=CreateStack
Create a New Stack
createStack 1 param body → 200400409500
POST
/?Action=UpdateStack
Update an Existing Stack
updateStack 1 param body → 200400404500
POST
/?Action=DeleteStack
Delete an Existing Stack
deleteStack 1 param body → 200400404409500
POST
/?Action=DescribeStacks
Describe One or More Stacks
describeStacks 1 param body → 200400500
POST
/?Action=ListStacks
List All Stacks
listStacks 1 param body → 200400500
POST
/?Action=CancelUpdateStack
Cancel a Stack Update in Progress
cancelUpdateStack 1 param body → 200400404500
POST
/?Action=ContinueUpdateRollback
Continue Rolling Back a Failed Stack Update
continueUpdateRollback 1 param body → 200400404500
POST
/?Action=RollbackStack
Rollback a Stack to a Previous Stable State
rollbackStack 1 param body → 200400404500
POST
/?Action=UpdateTerminationProtection
Enable or Disable Termination Protection on a Stack
updateTerminationProtection 1 param body → 200400404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Stack (25 properties), StackSummary (11 properties), Output (4 properties), Parameter (4 properties). Each schema is shown below with its type and property counts.

RollbackConfiguration
object
2 properties
Stack
object
25 properties 3 required
StackDriftInformation
object
2 properties 1 required
StackSummary
object
11 properties 3 required
Tag
object
2 properties 2 required
StackStatus
string
Parameter
object
4 properties
RollbackTrigger
object
2 properties 2 required
ErrorResponse
object
2 properties
Output
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudformation-stacks-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 Drift 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 Templates API