AWS::ApiGateway::Deployment DeploymentCanarySettings - 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 DeploymentCanarySettings

The DeploymentCanarySettings property type specifies settings for the canary deployment.


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 percentage (0.0-100.0) of traffic routed to the canary deployment.

Required: No

Type: Double

Update requires: Replacement


A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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: Replacement


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

Required: No

Type: Boolean

Update requires: Replacement

See also

  • Deployment in the Amazon API Gateway REST API Reference