Skip to content

Api Gateway  >  Structures  >  CanarySettings

CanarySettings

Structure Class

CanarySettings dataclass

Configuration settings of a canary deployment.

Attributes

deployment_id class-attribute instance-attribute 
deployment_id: str | None = None

The ID of the canary deployment.

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

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

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

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.

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

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