Amazon API Gateway · JSON Structure

V2 Create Stage Request Structure

CreateStageRequest schema from Amazon API Gateway v2 API

Type: object Properties: 3 Required: 1
API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

CreateStageRequest is a JSON Structure definition published by Amazon API Gateway, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

StageName DeploymentId AutoDeploy

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

JSON Structure

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