Skip to content

AwsApiGatewayCanarySettings

Source code in docs_src/capo_securityhub/types/aws_api_gateway_canary_settings.py
class AwsApiGatewayCanarySettings(TypedDict, closed=True):
    percent_traffic: NotRequired["capo_securityhub.types.double.Double"]
    """<p>The percentage of traffic that is diverted to a canary deployment.</p>"""
    deployment_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The deployment identifier for the canary deployment.</p>"""
    stage_variable_overrides: NotRequired["capo_securityhub.types.field_map.FieldMap"]
    """<p>Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.</p> <p>Each variable is represented as a string-to-string map between the stage variable name and the variable value.</p>"""
    use_stage_cache: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Indicates whether the canary deployment uses the stage cache.</p>"""

deployment_id instance-attribute

deployment_id: NotRequired[NonEmptyString]

The deployment identifier for the canary deployment.

percent_traffic instance-attribute

percent_traffic: NotRequired[Double]

The percentage of traffic that is diverted to a canary deployment.

stage_variable_overrides instance-attribute

stage_variable_overrides: NotRequired[FieldMap]

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

use_stage_cache instance-attribute

use_stage_cache: NotRequired[Boolean]

Indicates whether the canary deployment uses the stage cache.