AWS::ApiGateway::Deployment DeploymentCanarySettings

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" : Double,
  "StageVariableOverrides" : {Key : Value, ...},
  "UseStageCache" : Boolean
}

YAML

  PercentTraffic: Double
  StageVariableOverrides: 
    Key : Value
  UseStageCache: Boolean

Properties

PercentTraffic

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

Required: No

Type: Double

Update requires: Replacement

StageVariableOverrides

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: Replacement

UseStageCache

Whether the canary deployment uses the stage cache.

Required: No

Type: Boolean

Update requires: Replacement

See also

• Deployment in the Amazon API Gateway REST API Reference