You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::CanarySettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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,
}

Configuration settings of a canary deployment.

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_idString

The ID of the canary deployment.

Returns:

  • (String)


481
482
483
484
485
486
487
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 481

class CanarySettings < Struct.new(
  :percent_traffic,
  :deployment_id,
  :stage_variable_overrides,
  :use_stage_cache)
  include Aws::Structure
end

#percent_trafficFloat

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

Returns:

  • (Float)


481
482
483
484
485
486
487
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 481

class CanarySettings < Struct.new(
  :percent_traffic,
  :deployment_id,
  :stage_variable_overrides,
  :use_stage_cache)
  include Aws::Structure
end

#stage_variable_overridesHash<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.

Returns:

  • (Hash<String,String>)


481
482
483
484
485
486
487
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 481

class CanarySettings < Struct.new(
  :percent_traffic,
  :deployment_id,
  :stage_variable_overrides,
  :use_stage_cache)
  include Aws::Structure
end

#use_stage_cacheBoolean

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

Returns:

  • (Boolean)


481
482
483
484
485
486
487
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 481

class CanarySettings < Struct.new(
  :percent_traffic,
  :deployment_id,
  :stage_variable_overrides,
  :use_stage_cache)
  include Aws::Structure
end