Class: Aws::APIGateway::Types::DeploymentCanarySettings

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

Overview

The input configuration for a canary deployment.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#percent_traffic ⇒ Float

The percentage (0.0-100.0) of traffic routed to the canary deployment.

Returns:

  • (Float) 


1721
1722
1723
1724
1725
1726
1727
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1721

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

#stage_variable_overrides ⇒ Hash<String,String>

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

Returns:

  • (Hash<String,String>) 


1721
1722
1723
1724
1725
1726
1727
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1721

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

#use_stage_cache ⇒ Boolean

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

Returns:

  • (Boolean) 


1721
1722
1723
1724
1725
1726
1727
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1721

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