BehaviorCriteria
The criteria by which the behavior is determined to be normal.
Contents
- comparisonOperator
-
The operator that relates the thing measured (
metric) to the criteria (containing avalueorstatisticalThreshold). Valid operators include:-
string-list:in-setandnot-in-set -
number-list:in-setandnot-in-set -
ip-address-list:in-cidr-setandnot-in-cidr-set -
number:less-than,less-than-equals,greater-than, andgreater-than-equals
Type: String
Valid 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 | in-set | not-in-setRequired: No
-
- consecutiveDatapointsToAlarm
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- consecutiveDatapointsToClear
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- durationSeconds
-
Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example,
NUM_MESSAGES_SENT). For astatisticalThreshholdmetric 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. Cannot be used with list-based metric datatypes.Type: Integer
Required: No
- mlDetectionConfig
-
The configuration of an ML Detect
Type: MachineLearningDetectionConfig object
Required: No
- statisticalThreshold
-
A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
Type: StatisticalThreshold object
Required: No
- value
-
The value to be compared with the
metric.Type: MetricValue object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
