You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::CanarySettings
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CanarySettings
- Defined in:
- (unknown)
Overview
When passing CanarySettings as input to an Aws::Client method, you can use a vanilla Hash:
{
percent_traffic: 1.0,
deployment_id: "String",
stage_variable_overrides: {
"String" => "String",
},
use_stage_cache: false,
}
Configuration settings of a canary deployment.
Returned by:
Instance Attribute Summary collapse
-
#deployment_id ⇒ String
The ID of the canary deployment.
-
#percent_traffic ⇒ Float
The percent (0-100) of traffic diverted to a canary deployment.
-
#stage_variable_overrides ⇒ Hash<String,String>
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
-
#use_stage_cache ⇒ Boolean
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
Instance Attribute Details
#deployment_id ⇒ String
The ID of the canary deployment.
#percent_traffic ⇒ Float
The percent (0-100) of traffic diverted to a canary deployment.
#stage_variable_overrides ⇒ Hash<String,String>
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 ⇒ Boolean
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.