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

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

Overview

Configuration settings of a canary deployment.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_id ⇒ String

The ID of the canary deployment.

Returns:

  • (String) 


390
391
392
393
394
395
396
397
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 390

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

#percent_traffic ⇒ Float

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

Returns:

  • (Float) 


390
391
392
393
394
395
396
397
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 390

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

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

Returns:

  • (Hash<String,String>) 


390
391
392
393
394
395
396
397
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 390

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

#use_stage_cache ⇒ Boolean

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

Returns:

  • (Boolean) 


390
391
392
393
394
395
396
397
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 390

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