Class: AWSCDK::InternetMonitor::CfnMonitor::LocalHealthEventsConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
internet_monitor/cfn_monitor.rb

Overview

Configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance or availability issue, when scores cross a threshold for one or more city-networks.

Defines the percentages, for performance scores or availability scores, that are the local thresholds for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don't set a local health event threshold, the default value is 60%.

For more information, see Change health event thresholds in the Internet Monitor section of the Amazon CloudWatch User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(health_score_threshold: nil, min_traffic_impact: nil, status: nil) ⇒ LocalHealthEventsConfigProperty

Returns a new instance of LocalHealthEventsConfigProperty.

Parameters:

  • health_score_threshold (Numeric, nil) (defaults to: nil) —

    The health event threshold percentage set for a local health score.

  • min_traffic_impact (Numeric, nil) (defaults to: nil) —

    The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

  • status (String, nil) (defaults to: nil) —

    The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score.



840
841
842
843
844
845
846
847
 
# File 'internet_monitor/cfn_monitor.rb', line 840

def initialize(health_score_threshold: nil, min_traffic_impact: nil, status: nil)
  @health_score_threshold = health_score_threshold
  Jsii::Type.check_type(@health_score_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "healthScoreThreshold") unless @health_score_threshold.nil?
  @min_traffic_impact = min_traffic_impact
  Jsii::Type.check_type(@min_traffic_impact, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minTrafficImpact") unless @min_traffic_impact.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#health_score_threshold ⇒ Numeric? (readonly)

The health event threshold percentage set for a local health score.

Returns:

  • (Numeric, nil)

See Also:



853
854
855
 
# File 'internet_monitor/cfn_monitor.rb', line 853

def health_score_threshold
  @health_score_threshold
end

#min_traffic_impact ⇒ Numeric? (readonly)

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don't set a minimum traffic impact threshold, the default value is 0.01%.

Returns:

  • (Numeric, nil)

See Also:



860
861
862
 
# File 'internet_monitor/cfn_monitor.rb', line 860

def min_traffic_impact
  @min_traffic_impact
end

#status ⇒ String? (readonly)

The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score.

The status can be ENABLED or DISABLED .

Returns:

  • (String, nil)

See Also:



867
868
869
 
# File 'internet_monitor/cfn_monitor.rb', line 867

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



869
870
871
872
873
874
875
 
# File 'internet_monitor/cfn_monitor.rb', line 869

def self.jsii_properties
  {
    :health_score_threshold => "healthScoreThreshold",
    :min_traffic_impact => "minTrafficImpact",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



877
878
879
880
881
882
883
884
885
 
# File 'internet_monitor/cfn_monitor.rb', line 877

def to_jsii
  result = {}
  result.merge!({
    "healthScoreThreshold" => @health_score_threshold,
    "minTrafficImpact" => @min_traffic_impact,
    "status" => @status,
  })
  result.compact
end