Skip to content

CanarySettings

Used by
Source code in docs_src/capo_api_gateway/types/canary_settings.py 
14
15
16
17
18
19
20
21
22
23
24
class CanarySettings(TypedDict, closed=True):
    percent_traffic: "capo_api_gateway.types.double.Double"
    """<p>The percent (0-100) of traffic diverted to a canary deployment.</p>"""
    deployment_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The ID of the canary deployment.</p>"""
    stage_variable_overrides: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>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.</p>"""
    use_stage_cache: "capo_api_gateway.types.boolean.Boolean"
    """<p>A Boolean flag to indicate whether the canary deployment uses the stage cache or not.</p>"""

deployment_id instance-attribute 

deployment_id: NotRequired[String]

The ID of the canary deployment.

percent_traffic instance-attribute 

percent_traffic: Double

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

stage_variable_overrides instance-attribute 

stage_variable_overrides: NotRequired[MapOfStringToString]

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: Boolean

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