BehaviorProperty Struct
A Device Defender security profile behavior.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const behaviorProperty: iot.CfnSecurityProfile.BehaviorProperty = {
name: 'name',
// the properties below are optional
criteria: {
comparisonOperator: 'comparisonOperator',
consecutiveDatapointsToAlarm: 123,
consecutiveDatapointsToClear: 123,
durationSeconds: 123,
mlDetectionConfig: {
confidenceLevel: 'confidenceLevel',
},
statisticalThreshold: {
statistic: 'statistic',
},
value: {
cidrs: ['cidrs'],
count: 'count',
number: 123,
numbers: [123],
ports: [123],
strings: ['strings'],
},
},
exportMetric: false,
metric: 'metric',
metricDimension: {
dimensionName: 'dimensionName',
// the properties below are optional
operator: 'operator',
},
suppressAlerts: false,
};
Properties
criteriaIResolvable | CfnSecurityProfile.BehaviorCriteriaPropertycriteriatyping.Union[IResolvable, BehaviorCriteriaProperty]criteriaIResolvableCriteriaIResolvableCriteriainterface{}#The criteria that determine if a device is behaving normally in regard to the `metric` .
In the AWS IoT console, you can choose to be sent an alert through Amazon SNS when AWS IoT Device Defender detects that a device is behaving anomalously.
exportMetricboolean | IResolvableexport_metrictyping.Union[bool, IResolvable]exportMetricBooleanExportMetricboolExportMetricinterface{}#Value indicates exporting metrics related to the behavior when it is true.
What is measured by the behavior.
metricDimensionIResolvable | CfnSecurityProfile.MetricDimensionPropertymetric_dimensiontyping.Union[IResolvable, MetricDimensionProperty]metricDimensionIResolvableMetricDimensionIResolvableMetricDimensioninterface{}#The dimension of the metric.
The name you've given to the behavior.
suppressAlertsboolean | IResolvablesuppress_alertstyping.Union[bool, IResolvable]suppressAlertsBooleanSuppressAlertsboolSuppressAlertsinterface{}#The alert status.
If you set the value to true , alerts will be suppressed.