AWS::ApiGateway::Stage CanarySetting

Configuration settings of a canary deployment.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DeploymentId" : String,
  "PercentTraffic" : Number,
  "StageVariableOverrides" : {Key: Value, ...},
  "UseStageCache" : Boolean
}

YAML

  DeploymentId: String
  PercentTraffic: Number
  StageVariableOverrides: 
    Key: Value
  UseStageCache: Boolean

Properties

DeploymentId

The ID of the canary deployment.

Required: No

Type: String

Update requires: No interruption

PercentTraffic

The percent (0-100) of traffic diverted to a canary deployment.

Required: No

Type: Number

Minimum: 0

Maximum: 100

Update requires: No interruption

StageVariableOverrides

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

Required: No

Type: Object of String

Pattern: [a-zA-Z0-9]+

Update requires: No interruption

UseStageCache

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

Required: No

Type: Boolean

Update requires: No interruption

See also

• Stage in the Amazon API Gateway REST API Reference