CreateDeploymentRequest

GatewayHTTP APIREST APIServerlessWebSocket

Properties

Name	Type	Description
stageName	string	The name of the stage that the deployment is made to. If not specified, a new stage is created with a generated name.
stageDescription	string
description	string	A description for the deployment.
cacheClusterEnabled	boolean
cacheClusterSize	string
variables	object
canarySettings	object
tracingEnabled	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateDeploymentRequest",
  "type": "object",
  "properties": {
    "stageName": {
      "type": "string",
      "description": "The name of the stage that the deployment is made to. If not specified, a new stage is created with a generated name."
    },
    "stageDescription": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "description": "A description for the deployment."
    },
    "cacheClusterEnabled": {
      "type": "boolean"
    },
    "cacheClusterSize": {
      "type": "string",
      "enum": [
        "0.5",
        "1.6",
        "6.1",
        "13.5",
        "28.4",
        "58.2",
        "118",
        "237"
      ]
    },
    "variables": {
      "type": "object"
    },
    "canarySettings": {
      "$ref": "#/definitions/DeploymentCanarySettings"
    },
    "tracingEnabled": {
      "type": "boolean"
    }
  }
}