AwsApiGatewayCanarySettings - Amazon Security Hub
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).


Contains information about settings for canary deployment in the stage.



The deployment identifier for the canary deployment.

Type: String

Pattern: .*\S.*

Required: No


The percentage of traffic that is diverted to a canary deployment.

Type: Double

Required: No


Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

Type: String to string map

Key Pattern: .*\S.*

Value Pattern: .*\S.*

Required: No


Indicates whether the canary deployment uses the stage cache.

Type: Boolean

Required: No

See Also

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