AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon API Gateway Deployment DeploymentCanarySettings

The DeploymentCanarySettings property type specifies settings for the canary deployment.

DeploymentCanarySettings is a property of the AWS::ApiGateway::Deployment resource.


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


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


PercentTraffic: Double StageVariableOverrides: String: String UseStageCache: Boolean



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

Required: No

Type: Double

Update requires: Replacement


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: String to String map

Update requires: Replacement


Whether the canary deployment uses the stage cache or not.

Required: No

Type: Boolean

Update requires: Replacement

See Also

On this page: