The DeploymentCanarySettings property type specifies settings for the canary deployment.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"PercentTraffic" : Number,
"StageVariableOverrides" : {Key: Value, ...},
"UseStageCache" : Boolean
}
YAML
PercentTraffic: Number
StageVariableOverrides:
Key: Value
UseStageCache: Boolean
Properties
PercentTraffic-
The percentage (0.0-100.0) of traffic routed to the canary deployment.
Required: No
Type: Number
Update requires: Replacement
StageVariableOverrides-
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: Object of String
Pattern:
[a-zA-Z0-9]+Update requires: Replacement
UseStageCache-
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
-
CreateDeployment in the Amazon API Gateway REST API Reference
