AWS::ApiGateway::Deployment CanarySetting - Amazon CloudFormation
SyntaxPropertiesSee also
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 CanarySetting

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

CanarySetting is a property of the StageDescription property type.

Syntax

To declare this entity in your Amazon 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 percent (0-100) of traffic diverted to a canary deployment.

Required: No

Type: Number

Update requires: No interruption

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.

Required: No

Type: Object of String

Pattern: [a-zA-Z0-9]+

Update requires: No interruption

UseStageCache

A Boolean flag to indicate 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