AWS::ApiGateway::Stage CanarySetting - AWS CloudFormation

AWS::ApiGateway::Stage CanarySetting

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

CanarySetting is a property of the AWS::ApiGateway::Stage resource.


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


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


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



The identifier of the deployment that the stage points to.

Required: No

Type: String

Update requires: No interruption


The percentage (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.

Duplicates are not allowed.

Required: No

Type: Map of String

Update requires: No interruption


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