Stage

GatewayHTTP APIREST APIServerlessWebSocket

Properties

Name	Type	Description
deploymentId	string	The identifier of the deployment attached to this stage.
clientCertificateId	string	The identifier of a client certificate for an API stage.
stageName	string	The name of the stage.
description	string	The stage's description.
cacheClusterEnabled	boolean	Whether cache clustering is enabled for the stage.
cacheClusterSize	string	The stage's cache cluster size.
cacheClusterStatus	string
methodSettings	object
variables	object	Stage variables.
documentationVersion	string
accessLogSettings	object
canarySettings	object
tracingEnabled	boolean	Whether X-Ray tracing is enabled for this stage.
webAclArn	string	The ARN of the WebAcl associated with the stage.
tags	object
createdDate	string
lastUpdatedDate	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Stage",
  "type": "object",
  "properties": {
    "deploymentId": {
      "type": "string",
      "description": "The identifier of the deployment attached to this stage."
    },
    "clientCertificateId": {
      "type": "string",
      "description": "The identifier of a client certificate for an API stage."
    },
    "stageName": {
      "type": "string",
      "description": "The name of the stage."
    },
    "description": {
      "type": "string",
      "description": "The stage's description."
    },
    "cacheClusterEnabled": {
      "type": "boolean",
      "description": "Whether cache clustering is enabled for the stage."
    },
    "cacheClusterSize": {
      "type": "string",
      "description": "The stage's cache cluster size.",
      "enum": [
        "0.5",
        "1.6",
        "6.1",
        "13.5",
        "28.4",
        "58.2",
        "118",
        "237"
      ]
    },
    "cacheClusterStatus": {
      "type": "string",
      "enum": [
        "CREATE_IN_PROGRESS",
        "AVAILABLE",
        "DELETE_IN_PROGRESS",
        "NOT_AVAILABLE",
        "FLUSH_IN_PROGRESS"
      ]
    },
    "methodSettings": {
      "type": "object"
    },
    "variables": {
      "type": "object",
      "description": "Stage variables."
    },
    "documentationVersion": {
      "type": "string"
    },
    "accessLogSettings": {
      "$ref": "#/definitions/AccessLogSettings"
    },
    "canarySettings": {
      "$ref": "#/definitions/CanarySettings"
    },
    "tracingEnabled": {
      "type": "boolean",
      "description": "Whether X-Ray tracing is enabled for this stage."
    },
    "webAclArn": {
      "type": "string",
      "description": "The ARN of the WebAcl associated with the stage."
    },
    "tags": {
      "type": "object"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastUpdatedDate": {
      "type": "string",
      "format": "date-time"
    }
  }
}