Amazon CloudFormation Resources API

openapi: 3.2.0
info:
  title: Amazon Cloudformation Resources API
  version: '2010-05-15'
  description: 'Operations tagged Resources across 2 of this provider''s published API definitions: amazon-cloudformation-openapi.yml, amazon-cloudformation-resources-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cloudformation.amazonaws.com
  description: Amazon CloudFormation regional endpoint
- url: https://cloudformation.{region}.amazonaws.com
  description: Amazon CloudFormation regional endpoint
  variables:
    region:
      default: us-east-1
      description: The AWS region
tags:
- name: Resources
  description: Operations for managing stack resources
paths:
  /?Action=ListStackResources:
    get:
      operationId: ListStackResources
      summary: Amazon CloudFormation List stack resources
      description: Returns descriptions of all resources of the specified stack.
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - ListStackResources
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-05-15'
      - name: StackName
        in: query
        required: true
        description: The name or the unique stack ID.
        schema:
          type: string
      - name: NextToken
        in: query
        description: A string that identifies the next page of stack resources to retrieve.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListStackResourcesOutput'
        '400':
          description: Client error
        '500':
          description: Server error
      tags:
      - Resources
      security:
      - aws_auth: []
    post:
      operationId: post?Action=ListStackResources
      summary: List Stack Resources
      description: Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListStackResourcesOutput_2'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ListStackResources
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/ListStackResourcesInput'
      tags:
      - Resources
      security:
      - aws_auth: []
      x-operation-id-source: normalized
      x-operation-id-original: ListStackResources
    servers:
    - url: https://cloudformation.amazonaws.com
      description: Amazon CloudFormation regional endpoint
    - url: https://cloudformation.{region}.amazonaws.com
      description: Amazon CloudFormation regional endpoint
      variables:
        region:
          default: us-east-1
          description: The AWS region
  /?Action=DescribeStackResources:
    get:
      operationId: DescribeStackResources
      summary: Amazon CloudFormation Describe stack resources
      description: Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned.
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeStackResources
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-05-15'
      - name: StackName
        in: query
        description: The name or the unique stack ID.
        schema:
          type: string
      - name: LogicalResourceId
        in: query
        description: The logical name of the resource.
        schema:
          type: string
      - name: PhysicalResourceId
        in: query
        description: The name or unique identifier that corresponds to a physical instance ID of a resource.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeStackResourcesOutput'
        '400':
          description: Client error
        '500':
          description: Server error
      tags:
      - Resources
      security:
      - aws_auth: []
    post:
      operationId: post?Action=DescribeStackResources
      summary: Describe Stack Resources
      description: Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, see the CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeStackResourcesOutput_2'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeStackResources
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/DescribeStackResourcesInput'
      tags:
      - Resources
      security:
      - aws_auth: []
      x-operation-id-source: normalized
      x-operation-id-original: DescribeStackResources
    servers:
    - url: https://cloudformation.amazonaws.com
      description: Amazon CloudFormation regional endpoint
    - url: https://cloudformation.{region}.amazonaws.com
      description: Amazon CloudFormation regional endpoint
      variables:
        region:
          default: us-east-1
          description: The AWS region
components:
  schemas:
    ListStackResourcesOutput:
      type: object
      properties:
        StackResourceSummaries:
          type: array
          items:
            type: object
            properties:
              LogicalResourceId:
                type: string
              PhysicalResourceId:
                type: string
              ResourceType:
                type: string
              ResourceStatus:
                type: string
              ResourceStatusReason:
                type: string
              LastUpdatedTimestamp:
                type: string
                format: date-time
              DriftInformation:
                $ref: '#/components/schemas/StackResourceDriftInformation'
        NextToken:
          type: string
    StackResourceDriftInformation:
      type: object
      required:
      - StackResourceDriftStatus
      properties:
        StackResourceDriftStatus:
          type: string
          enum:
          - IN_SYNC
          - MODIFIED
          - DELETED
          - NOT_CHECKED
        LastCheckTimestamp:
          type: string
          format: date-time
    StackResource:
      type: object
      required:
      - LogicalResourceId
      - ResourceType
      - ResourceStatus
      - Timestamp
      properties:
        StackName:
          type: string
          description: The name associated with the stack.
        StackId:
          type: string
          description: Unique identifier of the stack.
        LogicalResourceId:
          type: string
          description: The logical name of the resource specified in the template.
        PhysicalResourceId:
          type: string
          description: The name or unique identifier of the resource.
        ResourceType:
          type: string
          description: Type of resource (e.g., AWS::EC2::Instance).
        Timestamp:
          type: string
          format: date-time
          description: Time the status was updated.
        ResourceStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_FAILED
          - CREATE_COMPLETE
          - DELETE_IN_PROGRESS
          - DELETE_FAILED
          - DELETE_COMPLETE
          - DELETE_SKIPPED
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_COMPLETE
          - IMPORT_FAILED
          - IMPORT_COMPLETE
          - IMPORT_IN_PROGRESS
          - IMPORT_ROLLBACK_IN_PROGRESS
          - IMPORT_ROLLBACK_FAILED
          - IMPORT_ROLLBACK_COMPLETE
          description: Current status of the resource.
        ResourceStatusReason:
          type: string
          description: Success or failure message associated with the resource.
        Description:
          type: string
          description: User defined description associated with the resource.
        DriftInformation:
          $ref: '#/components/schemas/StackResourceDriftInformation'
    DescribeStackResourcesOutput:
      type: object
      properties:
        StackResources:
          type: array
          items:
            $ref: '#/components/schemas/StackResource'
    DescribeStackResourcesOutput_2:
      type: object
      properties:
        StackResources:
          type: array
          items:
            $ref: '#/components/schemas/StackResource_2'
          description: A list of StackResource structures.
    DescribeStackResourcesInput:
      type: object
      properties:
        StackName:
          type: string
          description: 'The name or the unique stack ID that is associated with the stack, which aren''t always interchangeable: Running stacks: You can specify either the stack''s name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Required: Conditional. If you don''t specify StackName, you must specify PhysicalResourceId.'
        LogicalResourceId:
          type: string
          description: The logical name of the resource as specified in the template.
        PhysicalResourceId:
          type: string
          description: 'The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation. For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack. Required: Conditional. If you don''t specify PhysicalResourceId, you must specify StackName.'
    ListStackResourcesInput:
      type: object
      properties:
        StackName:
          type: string
          description: 'The name or the unique stack ID that is associated with the stack, which aren''t always interchangeable: Running stacks: You can specify either the stack''s name or its unique stack ID. Deleted stacks: You must specify the unique stack ID.'
        NextToken:
          type: string
          description: The token for the next set of items to return. (You received this token from a previous call.)
      required:
      - StackName
    StackResourceSummary:
      type: object
      properties:
        LogicalResourceId:
          type: string
          description: The logical name of the resource specified in the template.
        PhysicalResourceId:
          type: string
          description: The name or unique identifier that corresponds to a physical instance ID of the resource.
        ResourceType:
          type: string
          description: Type of resource. (For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.)
        LastUpdatedTimestamp:
          type: string
          format: date-time
          description: Time the status was updated.
        ResourceStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_FAILED
          - CREATE_COMPLETE
          - DELETE_IN_PROGRESS
          - DELETE_FAILED
          - DELETE_COMPLETE
          - DELETE_SKIPPED
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_COMPLETE
          - IMPORT_FAILED
          - IMPORT_COMPLETE
          - IMPORT_IN_PROGRESS
          - IMPORT_ROLLBACK_IN_PROGRESS
          - IMPORT_ROLLBACK_FAILED
          - IMPORT_ROLLBACK_COMPLETE
          - EXPORT_FAILED
          - EXPORT_COMPLETE
          - EXPORT_IN_PROGRESS
          - EXPORT_ROLLBACK_IN_PROGRESS
          - EXPORT_ROLLBACK_FAILED
          - EXPORT_ROLLBACK_COMPLETE
          - UPDATE_ROLLBACK_IN_PROGRESS
          - UPDATE_ROLLBACK_COMPLETE
          - UPDATE_ROLLBACK_FAILED
          - ROLLBACK_IN_PROGRESS
          - ROLLBACK_COMPLETE
          - ROLLBACK_FAILED
          description: Current status of the resource.
        ResourceStatusReason:
          type: string
          description: Success/failure message associated with the resource.
        DriftInformation:
          $ref: '#/components/schemas/StackResourceDriftInformationSummary'
        ModuleInfo:
          $ref: '#/components/schemas/ModuleInfo'
      required:
      - LogicalResourceId
      - ResourceType
      - LastUpdatedTimestamp
      - ResourceStatus
    ListStackResourcesOutput_2:
      type: object
      properties:
        StackResourceSummaries:
          type: array
          items:
            $ref: '#/components/schemas/StackResourceSummary'
          description: A list of StackResourceSummary structures.
        NextToken:
          type: string
          description: If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.
    ModuleInfo:
      type: object
      properties:
        TypeHierarchy:
          type: string
          description: A concatenated list of the module type or types that contains the resource. Module types are listed starting with the inner-most nested module, and separated by /. In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that's nested inside a parent module of type AWS::Second::Example::MODULE. AWS::First::Example::MODULE/AWS::Second::Example::MODULE
        LogicalIdHierarchy:
          type: string
          description: A concatenated list of the logical IDs of the module or modules that contains the resource. Modules are listed starting with the inner-most nested module, and separated by /. In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB. moduleA/moduleB For more information, see Reference module resources in CloudFormation templates in the CloudFormation User Guide.
    StackResourceDriftInformation_2:
      type: object
      properties:
        StackResourceDriftStatus:
          type: string
          enum:
          - IN_SYNC
          - MODIFIED
          - DELETED
          - NOT_CHECKED
          - UNKNOWN
          - UNSUPPORTED
          description: 'Status of the resource''s actual configuration compared to its expected configuration DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection. IN_SYNC: The resource''s actual configuration matches its expected configuration.'
        LastCheckTimestamp:
          type: string
          format: date-time
          description: When CloudFormation last checked if the resource had drifted from its expected configuration.
      required:
      - StackResourceDriftStatus
    StackResource_2:
      type: object
      properties:
        StackName:
          type: string
          description: The name associated with the stack.
        StackId:
          type: string
          description: Unique identifier of the stack.
        LogicalResourceId:
          type: string
          description: The logical name of the resource specified in the template.
        PhysicalResourceId:
          type: string
          description: The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
        ResourceType:
          type: string
          description: Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
        Timestamp:
          type: string
          format: date-time
          description: Time the status was updated.
        ResourceStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_FAILED
          - CREATE_COMPLETE
          - DELETE_IN_PROGRESS
          - DELETE_FAILED
          - DELETE_COMPLETE
          - DELETE_SKIPPED
          - UPDATE_IN_PROGRESS
          - UPDATE_FAILED
          - UPDATE_COMPLETE
          - IMPORT_FAILED
          - IMPORT_COMPLETE
          - IMPORT_IN_PROGRESS
          - IMPORT_ROLLBACK_IN_PROGRESS
          - IMPORT_ROLLBACK_FAILED
          - IMPORT_ROLLBACK_COMPLETE
          - EXPORT_FAILED
          - EXPORT_COMPLETE
          - EXPORT_IN_PROGRESS
          - EXPORT_ROLLBACK_IN_PROGRESS
          - EXPORT_ROLLBACK_FAILED
          - EXPORT_ROLLBACK_COMPLETE
          - UPDATE_ROLLBACK_IN_PROGRESS
          - UPDATE_ROLLBACK_COMPLETE
          - UPDATE_ROLLBACK_FAILED
          - ROLLBACK_IN_PROGRESS
          - ROLLBACK_COMPLETE
          - ROLLBACK_FAILED
          description: Current status of the resource.
        ResourceStatusReason:
          type: string
          description: Success/failure message associated with the resource.
        Description:
          type: string
          description: User defined description associated with the resource.
        DriftInformation:
          $ref: '#/components/schemas/StackResourceDriftInformation_2'
        ModuleInfo:
          $ref: '#/components/schemas/ModuleInfo'
      required:
      - LogicalResourceId
      - ResourceType
      - Timestamp
      - ResourceStatus
    StackResourceDriftInformationSummary:
      type: object
      properties:
        StackResourceDriftStatus:
          type: string
          enum:
          - IN_SYNC
          - MODIFIED
          - DELETED
          - NOT_CHECKED
          - UNKNOWN
          - UNSUPPORTED
          description: 'Status of the resource''s actual configuration compared to its expected configuration. DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: CloudFormation hasn''t checked if the resource differs from its expected configuration. Any resources that don''t currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection. If you performed a ContinueUpdateRollback operation on a stack, resources skipped using R'
        LastCheckTimestamp:
          type: string
          format: date-time
          description: When CloudFormation last checked if the resource had drifted from its expected configuration.
      required:
      - StackResourceDriftStatus
  securitySchemes:
    aws_auth:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cloudformation
x-refined-from:
- amazon-cloudformation-openapi.yml
- amazon-cloudformation-resources-api-openapi.yml