Interface CfnSecurityProfile.IBehaviorCriteriaProperty
The criteria by which the behavior is determined to be normal.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBehaviorCriteriaProperty
Syntax (vb)
Public Interface IBehaviorCriteriaProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var behaviorCriteriaProperty = new BehaviorCriteriaProperty {
ComparisonOperator = "comparisonOperator",
ConsecutiveDatapointsToAlarm = 123,
ConsecutiveDatapointsToClear = 123,
DurationSeconds = 123,
MlDetectionConfig = new MachineLearningDetectionConfigProperty {
ConfidenceLevel = "confidenceLevel"
},
StatisticalThreshold = new StatisticalThresholdProperty {
Statistic = "statistic"
},
Value = new MetricValueProperty {
Cidrs = new [] { "cidrs" },
Count = "count",
Number = 123,
Numbers = new [] { 123 },
Ports = new [] { 123 },
Strings = new [] { "strings" }
}
};
Synopsis
Properties
ComparisonOperator | The operator that relates the thing measured ( |
ConsecutiveDatapointsToAlarm | If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. |
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. |
DurationSeconds | Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, |
MlDetectionConfig | The confidence level of the detection model. |
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. |
Value | The value to be compared with the |
Properties
ComparisonOperator
The operator that relates the thing measured ( metric
) to the criteria (containing a value
or statisticalThreshold
).
virtual string ComparisonOperator { get; }
Property Value
System.String
Remarks
ConsecutiveDatapointsToAlarm
If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
virtual Nullable<double> ConsecutiveDatapointsToAlarm { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
virtual Nullable<double> ConsecutiveDatapointsToClear { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
).
virtual Nullable<double> DurationSeconds { get; }
Property Value
System.Nullable<System.Double>
Remarks
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. Cannot be used with list-based metric datatypes.
MlDetectionConfig
The confidence level of the detection model.
virtual object MlDetectionConfig { get; }
Property Value
System.Object
Remarks
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.
virtual object StatisticalThreshold { get; }
Property Value
System.Object
Remarks
Value
The value to be compared with the metric
.
virtual object Value { get; }
Property Value
System.Object