AWS CloudFormation API

openapi: 3.1.0
info:
  title: AWS CloudFormation API
  description: >-
    AWS CloudFormation gives you an easy way to model a collection of related
    AWS and third-party resources, provision them quickly and consistently, and
    manage them throughout their lifecycles. It uses templates to define stacks
    of resources and provides API operations for creating, updating, and
    deleting stacks. The API uses a query-style interface where all operations
    are submitted as POST requests with an Action parameter.
  version: '2010-05-15'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-logo:
    url: https://aws.amazon.com/cloudformation/logo.png
servers:
- url: https://cloudformation.{region}.amazonaws.com
  description: AWS CloudFormation Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
security:
- AWS_Signature_V4: []
tags:
- name: Stacks
  description: Operations for creating, updating, deleting, and describing CloudFormation stacks.
- name: Stack Events
  description: Operations for retrieving stack-related events.
- name: Stack Resources
  description: Operations for describing resources within a stack.
- name: Stack Drift
  description: Operations for detecting and describing configuration drift.
- name: Change Sets
  description: Operations for creating and managing change sets to preview stack changes.
- name: Templates
  description: Operations for retrieving, validating, and summarizing templates.
- name: Stack Sets
  description: Operations for managing stack sets across multiple accounts and regions.
- name: Stack Instances
  description: Operations for managing stack instances within a stack set.
- name: Stack Policies
  description: Operations for getting and setting stack policies.
- name: Registry
  description: Operations for managing extension types in the CloudFormation Registry.
- name: IaC Generator
  description: Operations for generating templates from existing resources.
- name: Exports
  description: Operations for listing stack exports and imports.
paths:
  /?Action=CreateStack:
    post:
      operationId: createStack
      summary: Create a New Stack
      description: >-
        Creates a stack as specified in the template. After the call completes
        successfully, the stack creation starts. You can check the status of the
        stack through the DescribeStacks operation.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              properties:
                StackName:
                  type: string
                  description: >-
                    The name associated with the stack. Must be unique within a
                    region. Max 128 characters, alphanumeric and hyphens.
                  maxLength: 128
                TemplateBody:
                  type: string
                  description: >-
                    Structure containing the template body with a minimum length
                    of 1 byte and a maximum length of 51,200 bytes.
                TemplateURL:
                  type: string
                  description: >-
                    Location of file containing the template body. Must be a URL
                    pointing to a template in an Amazon S3 bucket (max 1 MB).
                  format: uri
                Parameters:
                  type: array
                  description: A list of Parameter structures specifying input parameters for the stack.
                  items:
                    $ref: '#/components/schemas/Parameter'
                DisableRollback:
                  type: boolean
                  description: Set to true to disable rollback of the stack if stack creation fails.
                  default: false
                RollbackConfiguration:
                  $ref: '#/components/schemas/RollbackConfiguration'
                TimeoutInMinutes:
                  type: integer
                  description: >-
                    The amount of time that can pass before the stack status
                    becomes CREATE_FAILED.
                  minimum: 1
                NotificationARNs:
                  type: array
                  description: The Amazon SNS topic ARNs to publish stack related events.
                  items:
                    type: string
                  maxItems: 5
                Capabilities:
                  type: array
                  description: >-
                    A list of capabilities that you must specify before
                    CloudFormation can create certain stacks.
                  items:
                    type: string
                    enum:
                    - CAPABILITY_IAM
                    - CAPABILITY_NAMED_IAM
                    - CAPABILITY_AUTO_EXPAND
                OnFailure:
                  type: string
                  description: Determines what action to take if stack creation fails.
                  enum:
                  - DO_NOTHING
                  - ROLLBACK
                  - DELETE
                  default: ROLLBACK
                StackPolicyBody:
                  type: string
                  description: Structure containing the stack policy body (1-16,384 bytes).
                StackPolicyURL:
                  type: string
                  description: Location of a file containing the stack policy.
                  format: uri
                Tags:
                  type: array
                  description: Key-value pairs to associate with this stack. Max 50 tags.
                  items:
                    $ref: '#/components/schemas/Tag'
                  maxItems: 50
                RoleARN:
                  type: string
                  description: >-
                    The Amazon Resource Name (ARN) of an IAM role that
                    CloudFormation assumes to create the stack.
                  minLength: 20
                  maxLength: 2048
                EnableTerminationProtection:
                  type: boolean
                  description: Whether to enable termination protection on the stack.
                  default: false
                ClientRequestToken:
                  type: string
                  description: >-
                    A unique identifier for this CreateStack request. Max 128
                    characters.
                  maxLength: 128
                RetainExceptOnCreate:
                  type: boolean
                  description: When true, newly created resources are deleted when the operation rolls back.
                  default: false
            examples:
              CreatestackRequestExample:
                summary: Default createStack request
                x-microcks-default: true
                value:
                  StackName: example_value
                  TemplateBody: example_value
                  TemplateURL: https://www.example.com
                  Parameters:
                  - ParameterKey: example_value
                    ParameterValue: example_value
                    UsePreviousValue: true
                    ResolvedValue: example_value
                  DisableRollback: true
                  RollbackConfiguration:
                    RollbackTriggers:
                    - {}
                    MonitoringTimeInMinutes: 10
                  TimeoutInMinutes: 10
                  NotificationARNs:
                  - example_value
                  Capabilities:
                  - CAPABILITY_IAM
                  OnFailure: DO_NOTHING
                  StackPolicyBody: example_value
                  StackPolicyURL: https://www.example.com
                  Tags:
                  - Key: example_value
                    Value: example_value
                  RoleARN: example_value
                  EnableTerminationProtection: true
                  ClientRequestToken: example_value
                  RetainExceptOnCreate: true
      responses:
        '200':
          description: Stack creation initiated successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  CreateStackResult:
                    type: object
                    properties:
                      StackId:
                        type: string
                        description: Unique identifier of the stack.
              examples:
                Createstack200Example:
                  summary: Default createStack 200 response
                  x-microcks-default: true
                  value:
                    CreateStackResult:
                      StackId: '500123'
        '400':
          $ref: '#/components/responses/ValidationError'
        '409':
          $ref: '#/components/responses/AlreadyExistsError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=UpdateStack:
    post:
      operationId: updateStack
      summary: Update an Existing Stack
      description: >-
        Updates a stack as specified in the template. After the call completes
        successfully, the stack update starts. You can check the status of the
        stack through the DescribeStacks operation.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              properties:
                StackName:
                  type: string
                  description: The name or unique stack ID of the stack to update.
                TemplateBody:
                  type: string
                  description: Structure containing the updated template body.
                TemplateURL:
                  type: string
                  description: Location of the updated template in Amazon S3.
                  format: uri
                UsePreviousTemplate:
                  type: boolean
                  description: Reuse the existing template associated with the stack.
                Parameters:
                  type: array
                  items:
                    $ref: '#/components/schemas/Parameter'
                Capabilities:
                  type: array
                  items:
                    type: string
                    enum:
                    - CAPABILITY_IAM
                    - CAPABILITY_NAMED_IAM
                    - CAPABILITY_AUTO_EXPAND
                Tags:
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
                  maxItems: 50
                RoleARN:
                  type: string
                  minLength: 20
                  maxLength: 2048
                RollbackConfiguration:
                  $ref: '#/components/schemas/RollbackConfiguration'
                StackPolicyBody:
                  type: string
                StackPolicyURL:
                  type: string
                  format: uri
                StackPolicyDuringUpdateBody:
                  type: string
                  description: Temporary stack policy body used during the update.
                StackPolicyDuringUpdateURL:
                  type: string
                  description: Temporary stack policy URL used during the update.
                  format: uri
                NotificationARNs:
                  type: array
                  items:
                    type: string
                  maxItems: 5
                ClientRequestToken:
                  type: string
                  maxLength: 128
                DisableRollback:
                  type: boolean
                RetainExceptOnCreate:
                  type: boolean
            examples:
              UpdatestackRequestExample:
                summary: Default updateStack request
                x-microcks-default: true
                value:
                  StackName: example_value
                  TemplateBody: example_value
                  TemplateURL: https://www.example.com
                  UsePreviousTemplate: true
                  Parameters:
                  - ParameterKey: example_value
                    ParameterValue: example_value
                    UsePreviousValue: true
                    ResolvedValue: example_value
                  Capabilities:
                  - CAPABILITY_IAM
                  Tags:
                  - Key: example_value
                    Value: example_value
                  RoleARN: example_value
                  RollbackConfiguration:
                    RollbackTriggers:
                    - {}
                    MonitoringTimeInMinutes: 10
                  StackPolicyBody: example_value
                  StackPolicyURL: https://www.example.com
                  StackPolicyDuringUpdateBody: example_value
                  StackPolicyDuringUpdateURL: https://www.example.com
                  NotificationARNs:
                  - example_value
                  ClientRequestToken: example_value
                  DisableRollback: true
                  RetainExceptOnCreate: true
      responses:
        '200':
          description: Stack update initiated successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  UpdateStackResult:
                    type: object
                    properties:
                      StackId:
                        type: string
              examples:
                Updatestack200Example:
                  summary: Default updateStack 200 response
                  x-microcks-default: true
                  value:
                    UpdateStackResult:
                      StackId: '500123'
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DeleteStack:
    post:
      operationId: deleteStack
      summary: Delete an Existing Stack
      description: >-
        Deletes a specified stack. Once the call completes successfully, stack
        deletion starts. Deleted stacks do not show up in DescribeStacks calls
        by default.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              properties:
                StackName:
                  type: string
                  description: The name or unique stack ID of the stack to delete.
                RetainResources:
                  type: array
                  description: >-
                    A list of logical resource IDs for resources you want to
                    retain after stack deletion.
                  items:
                    type: string
                RoleARN:
                  type: string
                  description: IAM role ARN for CloudFormation to assume during deletion.
                  minLength: 20
                  maxLength: 2048
                ClientRequestToken:
                  type: string
                  maxLength: 128
                DeletionMode:
                  type: string
                  description: Specifies the deletion mode.
                  enum:
                  - STANDARD
                  - FORCE_DELETE_STACK
            examples:
              DeletestackRequestExample:
                summary: Default deleteStack request
                x-microcks-default: true
                value:
                  StackName: example_value
                  RetainResources:
                  - example_value
                  RoleARN: example_value
                  ClientRequestToken: example_value
                  DeletionMode: STANDARD
      responses:
        '200':
          description: Stack deletion initiated successfully.
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          description: Stack cannot be deleted due to termination protection.
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeStacks:
    post:
      operationId: describeStacks
      summary: Describe One or More Stacks
      description: >-
        Returns the description for the specified stack. If no stack name was
        specified, then it returns descriptions for all stacks. Use ListStacks
        instead if you do not need full stack details for performance reasons.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                StackName:
                  type: string
                  description: Stack name or unique ID. Required for deleted stacks to use unique ID.
                NextToken:
                  type: string
                  description: Token for pagination from a prior call.
                  maxLength: 1024
            examples:
              DescribestacksRequestExample:
                summary: Default describeStacks request
                x-microcks-default: true
                value:
                  StackName: example_value
                  NextToken: example_value
      responses:
        '200':
          description: Stack details returned successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  DescribeStacksResult:
                    type: object
                    properties:
                      Stacks:
                        type: array
                        items:
                          $ref: '#/components/schemas/Stack'
                      NextToken:
                        type: string
              examples:
                Describestacks200Example:
                  summary: Default describeStacks 200 response
                  x-microcks-default: true
                  value:
                    DescribeStacksResult:
                      Stacks:
                      - StackId: '500123'
                        StackName: example_value
                        ChangeSetId: '500123'
                        Description: A sample description.
                        CreationTime: '2026-01-15T10:30:00Z'
                        DeletionTime: '2026-01-15T10:30:00Z'
                        LastUpdatedTime: '2026-01-15T10:30:00Z'
                        StackStatusReason: example_value
                        DisableRollback: true
                        NotificationARNs: {}
                        TimeoutInMinutes: 10
                        Capabilities: {}
                        Outputs: {}
                        RoleARN: example_value
                        Tags: {}
                        EnableTerminationProtection: true
                        Parameters: {}
                        ParentId: '500123'
                        RootId: '500123'
                        DeletionMode: STANDARD
                        DetailedStatus: CONFIGURATION_COMPLETE
                        RetainExceptOnCreate: true
                      NextToken: example_value
        '400':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=ListStacks:
    post:
      operationId: listStacks
      summary: List All Stacks
      description: >-
        Returns summary information for all stacks. Deleted stacks are included
        for 90 days after deletion. You can filter by stack status.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                NextToken:
                  type: string
                  maxLength: 1024
                StackStatusFilter:
                  type: array
                  description: Filter stacks by status.
                  items:
                    $ref: '#/components/schemas/StackStatus'
            examples:
              ListstacksRequestExample:
                summary: Default listStacks request
                x-microcks-default: true
                value:
                  NextToken: example_value
                  StackStatusFilter:
                  - CREATE_IN_PROGRESS
      responses:
        '200':
          description: Stack summaries returned successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  ListStacksResult:
                    type: object
                    properties:
                      StackSummaries:
                        type: array
                        items:
                          $ref: '#/components/schemas/StackSummary'
                      NextToken:
                        type: string
              examples:
                Liststacks200Example:
                  summary: Default listStacks 200 response
                  x-microcks-default: true
                  value:
                    ListStacksResult:
                      StackSummaries:
                      - StackId: '500123'
                        StackName: example_value
                        TemplateDescription: example_value
                        CreationTime: '2026-01-15T10:30:00Z'
                        LastUpdatedTime: '2026-01-15T10:30:00Z'
                        DeletionTime: '2026-01-15T10:30:00Z'
                        StackStatusReason: example_value
                        ParentId: '500123'
                        RootId: '500123'
                      NextToken: example_value
        '400':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=CancelUpdateStack:
    post:
      operationId: cancelUpdateStack
      summary: Cancel a Stack Update in Progress
      description: >-
        Cancels an update on the specified stack. If the call completes
        successfully, the stack rolls back the update and reverts to the
        previous stack configuration.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              properties:
                StackName:
                  type: string
                ClientRequestToken:
                  type: string
                  maxLength: 128
            examples:
              CancelupdatestackRequestExample:
                summary: Default cancelUpdateStack request
                x-microcks-default: true
                value:
                  StackName: example_value
                  ClientRequestToken: example_value
      responses:
        '200':
          description: Stack update cancellation initiated.
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=ContinueUpdateRollback:
    post:
      operationId: continueUpdateRollback
      summary: Continue Rolling Back a Failed Stack Update
      description: >-
        For a specified stack in UPDATE_ROLLBACK_FAILED state, continues rolling
        back to the previous stable state. A stack enters this state when a
        resource fails during the update rollback process.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              properties:
                StackName:
                  type: string
                RoleARN:
                  type: string
                  minLength: 20
                  maxLength: 2048
                ResourcesToSkip:
                  type: array
                  items:
                    type: string
                ClientRequestToken:
                  type: string
                  maxLength: 128
            examples:
              ContinueupdaterollbackRequestExample:
                summary: Default continueUpdateRollback request
                x-microcks-default: true
                value:
                  StackName: example_value
                  RoleARN: example_value
                  ResourcesToSkip:
                  - example_value
                  ClientRequestToken: example_value
      responses:
        '200':
          description: Update rollback continuation initiated.
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=RollbackStack:
    post:
      operationId: rollbackStack
      summary: Rollback a Stack to a Previous Stable State
      description: >-
        Rolls back the specified stack to the last known stable state.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              properties:
                StackName:
                  type: string
                RoleARN:
                  type: string
                  minLength: 20
                  maxLength: 2048
                ClientRequestToken:
                  type: string
                  maxLength: 128
                RetainExceptOnCreate:
                  type: boolean
            examples:
              RollbackstackRequestExample:
                summary: Default rollbackStack request
                x-microcks-default: true
                value:
                  StackName: example_value
                  RoleARN: example_value
                  ClientRequestToken: example_value
                  RetainExceptOnCreate: true
      responses:
        '200':
          description: Stack rollback initiated successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  RollbackStackResult:
                    type: object
                    properties:
                      StackId:
                        type: string
              examples:
                Rollbackstack200Example:
                  summary: Default rollbackStack 200 response
                  x-microcks-default: true
                  value:
                    RollbackStackResult:
                      StackId: '500123'
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=UpdateTerminationProtection:
    post:
      operationId: updateTerminationProtection
      summary: Enable or Disable Termination Protection on a Stack
      description: >-
        Updates termination protection for the specified stack. If a user
        attempts to delete a stack with termination protection enabled, the
        operation fails and the stack remains unchanged.
      tags:
      - Stacks
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - StackName
              - EnableTerminationProtection
              properties:
                StackName:
                  type: string
                EnableTerminationProtection:
                  type: boolean
            examples:
              UpdateterminationprotectionRequestExample:
                summary: Default updateTerminationProtection request
                x-microcks-default: true
                value:
                  StackName: example_value
                  EnableTerminationProtection: true
      responses:
        '200':
          description: Termination protection updated.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  UpdateTerminationProtectionResult:
                    type: object
                    properties:
                      StackId:
                        type: string
              examples:
                Updateterminationprotection200Example:
                  summary: Default updateTerminationProtection 200 response
                  x-microcks-default: true
                  value:
                    UpdateTerminationProtectionResult:
                      StackId: '500123'
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalError'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeStackEvents:
    post:
      operationId: describeStackEvents
      summary: Retrieve Events for a Stack
      description: >-
        Returns all stack-related events for a specified stack in reverse
        chronological order.
      tags:
      - Stack Events
      parameters:
      - $ref: '#/components/parameters/VersionParam'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                StackName:
                  type: string
                NextToken:
                  type: string
                  maxLength: 1024
            examples:
              DescribestackeventsRequestExample:
                summary: Default describeStackEvents request
                x-microcks-default: true
                value:
                  StackName: example_value
                  NextToken: example_value
      responses:
        '200':
          description: Stack events returned successfully.
          content:
            application/xml:
              schema:
                type: object
                properties:
                  DescribeStackEventsResult:
                    type: object
                    properties:
                      StackEvents:
                        type: array
                        items:
                          $ref: '#/components/schemas/StackEvent'
                      NextToken:
                        type: string
              examples:
                Describestackevents200Example:
                  

# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudformation/refs/heads/main/openapi/cloudformation-api.yml