Class: AWSCDK::XRay::CfnSamplingRule::SamplingRateBoostProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::XRay::CfnSamplingRule::SamplingRateBoostProperty

Defined in:

x_ray/cfn_sampling_rule.rb

Overview

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrateboost.html

Instance Attribute Summary

• #cooldown_window_minutes ⇒ Numeric readonly

  Time window (in minutes) in which only one sampling rate boost can be triggered.

• #max_rate ⇒ Numeric readonly

  The maximum sampling rate X-Ray will apply when it detects anomalies.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(cooldown_window_minutes:, max_rate:) ⇒ SamplingRateBoostProperty constructor

  A new instance of SamplingRateBoostProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(cooldown_window_minutes:, max_rate:) ⇒ SamplingRateBoostProperty

Returns a new instance of SamplingRateBoostProperty.

Parameters:

• cooldown_window_minutes (Numeric) —

  Time window (in minutes) in which only one sampling rate boost can be triggered.

• max_rate (Numeric) —

  The maximum sampling rate X-Ray will apply when it detects anomalies.

# File 'x_ray/cfn_sampling_rule.rb', line 569

def initialize(cooldown_window_minutes:, max_rate:)
  @cooldown_window_minutes = cooldown_window_minutes
  Jsii::Type.check_type(@cooldown_window_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cooldownWindowMinutes")
  @max_rate = max_rate
  Jsii::Type.check_type(@max_rate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxRate")
end

Instance Attribute Details

#cooldown_window_minutes ⇒ Numeric (readonly)

Time window (in minutes) in which only one sampling rate boost can be triggered.

After a boost occurs, no further boosts are allowed until the next window.

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrateboost.html#cfn-xray-samplingrule-samplingrateboost-cooldownwindowminutes

# File 'x_ray/cfn_sampling_rule.rb', line 582

def cooldown_window_minutes
  @cooldown_window_minutes
end

#max_rate ⇒ Numeric (readonly)

The maximum sampling rate X-Ray will apply when it detects anomalies.

X-Ray determines the appropriate rate between your baseline and the maximum, depending on anomaly activity.

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrateboost.html#cfn-xray-samplingrule-samplingrateboost-maxrate

# File 'x_ray/cfn_sampling_rule.rb', line 589

def max_rate
  @max_rate
end

Class Method Details

.jsii_properties ⇒ Object

# File 'x_ray/cfn_sampling_rule.rb', line 591

def self.jsii_properties
  {
    :cooldown_window_minutes => "cooldownWindowMinutes",
    :max_rate => "maxRate",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'x_ray/cfn_sampling_rule.rb', line 598

def to_jsii
  result = {}
  result.merge!({
    "cooldownWindowMinutes" => @cooldown_window_minutes,
    "maxRate" => @max_rate,
  })
  result.compact
end