class Aws::APIGateway::Types::CanarySettings

Configuration settings of a canary deployment.

@note When making an API call, you may pass CanarySettings

data as a hash:

    {
      percent_traffic: 1.0,
      deployment_id: "String",
      stage_variable_overrides: {
        "String" => "String",
      },
      use_stage_cache: false,
    }

@!attribute [rw] percent_traffic

The percent (0-100) of traffic diverted to a canary deployment.
@return [Float]

@!attribute [rw] deployment_id

The ID of the canary deployment.
@return [String]

@!attribute [rw] stage_variable_overrides

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.
@return [Hash<String,String>]

@!attribute [rw] use_stage_cache

A Boolean flag to indicate whether the canary deployment uses the
stage cache or not.
@return [Boolean]

Constants

SENSITIVE