Skip to content

DeploymentCanarySettings

Used by
Source code in docs_src/capo_api_gateway/types/deployment_canary_settings.py 
13
14
15
16
17
18
19
20
21
class DeploymentCanarySettings(TypedDict, closed=True):
    percent_traffic: "capo_api_gateway.types.double.Double"
    """<p>The percentage (0.0-100.0) of traffic routed to the canary deployment.</p>"""
    stage_variable_overrides: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>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.</p>"""
    use_stage_cache: "capo_api_gateway.types.boolean.Boolean"
    """<p>A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.</p>"""

percent_traffic instance-attribute 

percent_traffic: Double

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

stage_variable_overrides instance-attribute 

stage_variable_overrides: NotRequired[MapOfStringToString]

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 instance-attribute 

use_stage_cache: Boolean

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