AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::SecurityHub::Types::AwsApiGatewayCanarySettings

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

Overview

Note:

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

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

Contains information about settings for canary deployment in the stage.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_idString

The deployment identifier for the canary deployment.

Returns:

  • (String)

    The deployment identifier for the canary deployment.

#percent_trafficFloat

The percentage of traffic that is diverted to a canary deployment.

Returns:

  • (Float)

    The percentage of traffic that is diverted to a canary deployment.

#stage_variable_overridesHash<String,String>

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

Returns:

  • (Hash<String,String>)

    Stage variables that are overridden in the canary release deployment.

#use_stage_cacheBoolean

Indicates whether the canary deployment uses the stage cache.

Returns:

  • (Boolean)

    Indicates whether the canary deployment uses the stage cache.