CanarySettings

GatewayHTTP APIREST APIServerlessWebSocket

Properties

Name	Type	Description
percentTraffic	number	The percent of traffic the canary deployment receives.
deploymentId	string
stageVariableOverrides	object
useStageCache	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CanarySettings",
  "type": "object",
  "properties": {
    "percentTraffic": {
      "type": "number",
      "description": "The percent of traffic the canary deployment receives."
    },
    "deploymentId": {
      "type": "string"
    },
    "stageVariableOverrides": {
      "type": "object"
    },
    "useStageCache": {
      "type": "boolean"
    }
  }
}