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

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

Overview

Note:

When making an API call, you may pass AwsApiGatewayCanarySettings data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_idString

The deployment identifier for the canary deployment.

Returns:

  • (String)


712
713
714
715
716
717
718
719
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 712

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

#percent_trafficFloat

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

Returns:

  • (Float)


712
713
714
715
716
717
718
719
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 712

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

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


712
713
714
715
716
717
718
719
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 712

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

#use_stage_cacheBoolean

Indicates whether the canary deployment uses the stage cache.

Returns:

  • (Boolean)


712
713
714
715
716
717
718
719
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 712

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