libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.Types.Behavior

Description

 
Synopsis

Documentation

data Behavior Source #

A Device Defender security profile behavior.

See: newBehavior smart constructor.

Constructors

Behavior' 

Fields

  • suppressAlerts :: Maybe Bool

    Suppresses alerts.

  • metricDimension :: Maybe 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.

  • metric :: Maybe Text

    What is measured by the behavior.

  • criteria :: Maybe BehaviorCriteria

    The criteria that determine if a device is behaving normally in regard to the metric.

  • name :: Text

    The name you've given to the behavior.

Instances

Instances details
Eq Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

Read Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

Show Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

Generic Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

Associated Types

type Rep Behavior :: Type -> Type #

Methods

from :: Behavior -> Rep Behavior x #

to :: Rep Behavior x -> Behavior #

NFData Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

Methods

rnf :: Behavior -> () #

Hashable Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

Methods

hashWithSalt :: Int -> Behavior -> Int #

hash :: Behavior -> Int #

ToJSON Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

FromJSON Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

type Rep Behavior Source # 
Instance details

Defined in Amazonka.IoT.Types.Behavior

newBehavior Source #

Create a value of Behavior with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:suppressAlerts:Behavior', behavior_suppressAlerts - Suppresses alerts.

$sel:metricDimension:Behavior', behavior_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.

$sel:metric:Behavior', behavior_metric - What is measured by the behavior.

$sel:criteria:Behavior', behavior_criteria - The criteria that determine if a device is behaving normally in regard to the metric.

$sel:name:Behavior', behavior_name - The name you've given to the behavior.

behavior_metricDimension :: Lens' Behavior (Maybe MetricDimension) Source #

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.

behavior_metric :: Lens' Behavior (Maybe Text) Source #

What is measured by the behavior.

behavior_criteria :: Lens' Behavior (Maybe BehaviorCriteria) Source #

The criteria that determine if a device is behaving normally in regard to the metric.

behavior_name :: Lens' Behavior Text Source #

The name you've given to the behavior.