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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeploymentCanarySettings as input to an Aws::Client method, you can use a vanilla Hash:

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

The input configuration for a canary deployment.

Returned by:

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) —

    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. 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>) —

    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.

Returns:

  • (Boolean) —

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