CreateStageRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateStageRequest",
  "title": "CreateStageRequest",
  "type": "object",
  "required": [
    "stageName",
    "deploymentId"
  ],
  "properties": {
    "stageName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters."
        }
      ]
    },
    "deploymentId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The identifier of the Deployment resource for the Stage resource."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of the Stage resource."
        }
      ]
    },
    "cacheClusterEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Whether cache clustering is enabled for the stage."
        }
      ]
    },
    "cacheClusterSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CacheClusterSize"
        },
        {
          "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html\">Enabling API caching to enhance responsiveness</a>."
        }
      ]
    },
    "variables": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&amp;=,]+</code>."
        }
      ]
    },
    "documentationVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The version of the associated API documentation."
        }
      ]
    },
    "canarySettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CanarySettings"
        },
        {
          "description": "The canary deployment settings of this stage."
        }
      ]
    },
    "tracingEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Specifies whether active tracing with X-ray is enabled for the Stage."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters."
        }
      ]
    }
  },
  "description": "Requests API Gateway to create a Stage resource."
}