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

Class: Aws::IoT::Types::BehaviorCriteria

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

Overview

Note:

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

{
  comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set
  value: {
    count: 1,
    cidrs: ["Cidr"],
    ports: [1],
  },
  duration_seconds: 1,
  consecutive_datapoints_to_alarm: 1,
  consecutive_datapoints_to_clear: 1,
  statistical_threshold: {
    statistic: "EvaluationStatistic",
  },
}

The criteria by which the behavior is determined to be normal.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operator ⇒ String

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).

Possible values:

  • less-than
  • less-than-equals
  • greater-than
  • greater-than-equals
  • in-cidr-set
  • not-in-cidr-set
  • in-port-set
  • not-in-port-set

Returns:

  • (String) —

    The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).

#consecutive_datapoints_to_alarm ⇒ Integer

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

Returns:

  • (Integer) —

    If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.

#consecutive_datapoints_to_clear ⇒ Integer

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

Returns:

  • (Integer) —

    If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared.

#duration_seconds ⇒ Integer

Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

Returns:

  • (Integer) —

    Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT).

#statistical_threshold ⇒ Types::StatisticalThreshold

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Returns:

  • (Types::StatisticalThreshold) —

    A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

#value ⇒ Types::MetricValue

The value to be compared with the metric.

Returns: