DeploymentCanarySettings - Amazon API Gateway
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).

DeploymentCanarySettings

The input configuration for a canary deployment.

Contents

percentTraffic

The percentage (0.0-100.0) of traffic routed to the canary deployment.

Type: Double

Required: No

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.

Type: String to string map

Required: No

useStageCache

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: