Class CfnSecurityProfile.BehaviorCriteriaProperty

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

Inheritance

object

CfnSecurityProfile.BehaviorCriteriaProperty

Implements

CfnSecurityProfile.IBehaviorCriteriaProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSecurityProfile.BehaviorCriteriaProperty : CfnSecurityProfile.IBehaviorCriteriaProperty

Syntax (vb)

Public Class CfnSecurityProfile.BehaviorCriteriaProperty Implements CfnSecurityProfile.IBehaviorCriteriaProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html

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

Constructors

BehaviorCriteriaProperty()

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

Properties

ComparisonOperator	The operator that relates the thing measured ( `metric` ) to the criteria (containing a `value` or `statisticalThreshold` ).
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, `NUM_MESSAGES_SENT` ).
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 `metric` .

Constructors

BehaviorCriteriaProperty()

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

public BehaviorCriteriaProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html

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" }
                 }
             };

Properties

ComparisonOperator

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

public string? ComparisonOperator { get; set; }

Property Value

string

Remarks

Valid operators include:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-comparisonoperator

ConsecutiveDatapointsToAlarm

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

public double? ConsecutiveDatapointsToAlarm { get; set; }

Property Value

double?

Remarks

If not specified, the default is 1.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-consecutivedatapointstoalarm

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.

public double? ConsecutiveDatapointsToClear { get; set; }

Property Value

double?

Remarks

If not specified, the default is 1.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-consecutivedatapointstoclear

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 ).

public double? DurationSeconds { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-durationseconds

MlDetectionConfig

The confidence level of the detection model.

public object? MlDetectionConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-mldetectionconfig

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.

public object? StatisticalThreshold { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-statisticalthreshold

Value

The value to be compared with the metric .

public object? Value { get; set; }