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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::DeploymentCanarySettings

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass DeploymentCanarySettings data as a hash:

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

The input configuration for a canary deployment.

Instance Attribute Summary

• #percent_traffic ⇒ Float

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

• #stage_variable_overrides ⇒ Hash<String,String>

  A stage variable overrides used for the canary release deployment.

• #use_stage_cache ⇒ Boolean

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

Instance Attribute Details

#percent_traffic ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-apigateway/types.rb', line 2021

class DeploymentCanarySettings < Struct.new(
  :percent_traffic,
  :stage_variable_overrides,
  :use_stage_cache)
  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>)

# File 'lib/aws-sdk-apigateway/types.rb', line 2021

class DeploymentCanarySettings < Struct.new(
  :percent_traffic,
  :stage_variable_overrides,
  :use_stage_cache)
  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)

# File 'lib/aws-sdk-apigateway/types.rb', line 2021

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