Skip to content

CanarySettingsDict

Dictionary Type

CanarySettingsDict

Bases: TypedDict

Dictionary form of CanarySettings.

Attributes

deployment_id instance-attribute
deployment_id: str | None

The ID of the canary deployment.

percent_traffic instance-attribute
percent_traffic: float | None

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

stage_variable_overrides instance-attribute
stage_variable_overrides: Mapping[str, str] | 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 instance-attribute
use_stage_cache: bool | None

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