Skip to content

Api Gateway  >  Structures  >  DeploymentCanarySettings

DeploymentCanarySettings

Structure Class

DeploymentCanarySettings dataclass

The input configuration for a canary deployment.

Attributes

percent_traffic class-attribute instance-attribute
percent_traffic: float = 0

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

stage_variable_overrides class-attribute instance-attribute
stage_variable_overrides: dict[str, str] | None = None

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.

use_stage_cache class-attribute instance-attribute
use_stage_cache: bool = False

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