A Device Defender security profile behavior.
Contents
- name
-
The name you've given to the behavior.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: Yes
- criteria
-
The criteria that determine if a device is behaving normally in regard to the
metric.Note
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.
Type: BehaviorCriteria object
Required: No
- exportMetric
-
Value indicates exporting metrics related to the behavior when it is true.
Type: Boolean
Required: No
- metric
-
What is measured by the behavior.
Type: String
Required: No
- metricDimension
-
The dimension for a metric in your behavior. For example, using a
TOPIC_FILTERdimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.Type: MetricDimension object
Required: No
- suppressAlerts
-
Suppresses alerts.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
