V2 Stage Structure

Stage schema from Amazon API Gateway v2 API

Type: object Properties: 4

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Stage is a JSON Structure definition published by Amazon API Gateway, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

StageName DeploymentId Description AutoDeploy

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "type": "object",
  "properties": {
    "StageName": {
      "type": "string",
      "description": "Name of the stage.",
      "example": "my-resource"
    },
    "DeploymentId": {
      "type": "string",
      "description": "Deployment identifier.",
      "example": "abc123"
    },
    "Description": {
      "type": "string",
      "description": "Description of the stage.",
      "example": "A description of this resource."
    },
    "AutoDeploy": {
      "type": "boolean",
      "description": "Whether updates auto-deploy to this stage.",
      "example": true
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v2-stage-structure.json",
  "name": "Stage",
  "description": "Stage schema from Amazon API Gateway v2 API"
}