Struct Behavior

#[non_exhaustive]
pub struct Behavior {
    pub name: String,
    pub metric: Option<String>,
    pub metric_dimension: Option<MetricDimension>,
    pub criteria: Option<BehaviorCriteria>,
    pub suppress_alerts: Option<bool>,
    pub export_metric: Option<bool>,
}

A Device Defender security profile behavior.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name you've given to the behavior.

metric: Option<String>

What is measured by the behavior.

metric_dimension: Option<MetricDimension>

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, 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.

criteria: Option<BehaviorCriteria>

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.

suppress_alerts: Option<bool>

Suppresses alerts.

export_metric: Option<bool>

Value indicates exporting metrics related to the behavior when it is true.

Implementations

impl Behavior

pub fn name(&self) -> &str

The name you've given to the behavior.

pub fn metric(&self) -> Option<&str>

What is measured by the behavior.

pub fn metric_dimension(&self) -> Option<&MetricDimension>

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, 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.

pub fn criteria(&self) -> Option<&BehaviorCriteria>

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.

pub fn suppress_alerts(&self) -> Option<bool>

Suppresses alerts.

pub fn export_metric(&self) -> Option<bool>

Value indicates exporting metrics related to the behavior when it is true.

impl Behavior

pub fn builder() -> BehaviorBuilder

Creates a new builder-style object to manufacture Behavior.

Trait Implementations

impl Clone for Behavior

fn clone(&self) -> Behavior

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Behavior

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Behavior

fn eq(&self, other: &Behavior) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Behavior