AWS::ApiGateway::Deployment CanarySetting - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ApiGateway::Deployment CanarySetting

The CanarySetting property type specifies settings for the canary deployment in this stage.

CanarySetting is a property of the StageDescription property type.


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


{ "PercentTraffic" : Double, "StageVariableOverrides" : {Key : Value, ...}, "UseStageCache" : Boolean }


PercentTraffic: Double StageVariableOverrides: Key : Value UseStageCache: Boolean



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

Required: No

Type: Double

Update requires: No interruption


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: Map of String

Update requires: No interruption


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