Package software.amazon.awscdk.services.iot

Interface CfnSecurityProfile.BehaviorCriteriaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityProfile.BehaviorCriteriaProperty.Jsii$Proxy

Enclosing class:

CfnSecurityProfile

@Stability(Stable)
public static interface CfnSecurityProfile.BehaviorCriteriaProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 BehaviorCriteriaProperty behaviorCriteriaProperty = BehaviorCriteriaProperty.builder()
         .comparisonOperator("comparisonOperator")
         .consecutiveDatapointsToAlarm(123)
         .consecutiveDatapointsToClear(123)
         .durationSeconds(123)
         .mlDetectionConfig(MachineLearningDetectionConfigProperty.builder()
                 .confidenceLevel("confidenceLevel")
                 .build())
         .statisticalThreshold(StatisticalThresholdProperty.builder()
                 .statistic("statistic")
                 .build())
         .value(MetricValueProperty.builder()
                 .cidrs(List.of("cidrs"))
                 .count("count")
                 .number(123)
                 .numbers(List.of(123))
                 .ports(List.of(123))
                 .strings(List.of("strings"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSecurityProfile.BehaviorCriteriaProperty.Builder	A builder for CfnSecurityProfile.BehaviorCriteriaProperty
static final class	CfnSecurityProfile.BehaviorCriteriaProperty.Jsii$Proxy	An implementation for CfnSecurityProfile.BehaviorCriteriaProperty

Method Summary

Modifier and Type	Method	Description
static CfnSecurityProfile.BehaviorCriteriaProperty.Builder	builder()
default String	getComparisonOperator()	The operator that relates the thing measured ( metric ) to the criteria (containing a value or statisticalThreshold ).
default Number	getConsecutiveDatapointsToAlarm()	If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
default Number	getConsecutiveDatapointsToClear()	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.
default Number	getDurationSeconds()	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 ).
default Object	getMlDetectionConfig()	The confidence level of the detection model.
default Object	getStatisticalThreshold()	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.
default Object	getValue()	The value to be compared with the metric .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComparisonOperator

@Stability(Stable)
@Nullable
default String getComparisonOperator()

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

Valid operators include:

• string-list : in-set and not-in-set
• number-list : in-set and not-in-set
• ip-address-list : in-cidr-set and not-in-cidr-set
• number : less-than , less-than-equals , greater-than , and greater-than-equals

See Also:

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

getConsecutiveDatapointsToAlarm

@Stability(Stable)
@Nullable
default Number getConsecutiveDatapointsToAlarm()

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.

See Also:

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

getConsecutiveDatapointsToClear

@Stability(Stable)
@Nullable
default Number getConsecutiveDatapointsToClear()

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.

See Also:

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

getDurationSeconds

@Stability(Stable)
@Nullable
default Number getDurationSeconds()

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 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 Also:

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

getMlDetectionConfig

@Stability(Stable)
@Nullable
default Object getMlDetectionConfig()

The confidence level of the detection model.

See Also:

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

getStatisticalThreshold

@Stability(Stable)
@Nullable
default Object getStatisticalThreshold()

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.

See Also:

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

getValue

@Stability(Stable)
@Nullable
default Object getValue()

The value to be compared with the metric .

See Also:

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

builder

@Stability(Stable)
static CfnSecurityProfile.BehaviorCriteriaProperty.Builder builder()

Returns:

a CfnSecurityProfile.BehaviorCriteriaProperty.Builder of CfnSecurityProfile.BehaviorCriteriaProperty