/AWS1/CL_IOTBEHAVIOR¶
A Device Defender security profile behavior.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/IOTBEHAVIORNAME /AWS1/IOTBEHAVIORNAME¶
The name you've given to the behavior.
Optional arguments:¶
IV_METRIC TYPE /AWS1/IOTBEHAVIORMETRIC /AWS1/IOTBEHAVIORMETRIC¶
What is measured by the behavior.
IO_METRICDIMENSION TYPE REF TO /AWS1/CL_IOTMETRICDIMENSION /AWS1/CL_IOTMETRICDIMENSION¶
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.
IO_CRITERIA TYPE REF TO /AWS1/CL_IOTBEHAVIORCRITERIA /AWS1/CL_IOTBEHAVIORCRITERIA¶
The criteria that determine if a device is behaving normally in regard to the
metric.In the IoT console, you can choose to be sent an alert through Amazon SNS when IoT Device Defender detects that a device is behaving anomalously.
IV_SUPPRESSALERTS TYPE /AWS1/IOTSUPPRESSALERTS /AWS1/IOTSUPPRESSALERTS¶
Suppresses alerts.
IV_EXPORTMETRIC TYPE /AWS1/IOTEXPORTMETRIC /AWS1/IOTEXPORTMETRIC¶
Value indicates exporting metrics related to the behavior when it is true.
Queryable Attributes¶
name¶
The name you've given to the behavior.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
metric¶
What is measured by the behavior.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METRIC() |
Getter for METRIC, with configurable default |
ASK_METRIC() |
Getter for METRIC w/ exceptions if field has no value |
HAS_METRIC() |
Determine if METRIC has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METRICDIMENSION() |
Getter for METRICDIMENSION |
criteria¶
The criteria that determine if a device is behaving normally in regard to the
metric.In the IoT console, you can choose to be sent an alert through Amazon SNS when IoT Device Defender detects that a device is behaving anomalously.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CRITERIA() |
Getter for CRITERIA |
suppressAlerts¶
Suppresses alerts.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUPPRESSALERTS() |
Getter for SUPPRESSALERTS, with configurable default |
ASK_SUPPRESSALERTS() |
Getter for SUPPRESSALERTS w/ exceptions if field has no valu |
HAS_SUPPRESSALERTS() |
Determine if SUPPRESSALERTS has a value |
exportMetric¶
Value indicates exporting metrics related to the behavior when it is true.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPORTMETRIC() |
Getter for EXPORTMETRIC, with configurable default |
ASK_EXPORTMETRIC() |
Getter for EXPORTMETRIC w/ exceptions if field has no value |
HAS_EXPORTMETRIC() |
Determine if EXPORTMETRIC has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_BEHAVIORS¶
TYPES TT_BEHAVIORS TYPE STANDARD TABLE OF REF TO /AWS1/CL_IOTBEHAVIOR WITH DEFAULT KEY
.