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

Amazon API Gateway Stage CanarySetting

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

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

Syntax

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

JSON

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

YAML

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

Properties

DeploymentId

The identifier of the deployment that the stage points to.

Required: No

Type: String

Update requires: No interruption

PercentTraffic

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

Required: No

Type: Double

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.

Duplicates are not allowed.

Required: No

Type: String to String map

Update requires: No interruption

UseStageCache

Whether the canary deployment uses the stage cache or not.

Required: No

Type: Boolean

Update requires: No interruption

See Also

  • Stage in the API Gateway API Reference

On this page: