Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.Types.Behavior

Description

Synopsis

data Behavior = Behavior' {
- suppressAlerts :: Maybe Bool
- metricDimension :: Maybe MetricDimension
- metric :: Maybe Text
- criteria :: Maybe BehaviorCriteria
- name :: Text
}
newBehavior :: Text -> Behavior
behavior_suppressAlerts :: Lens' Behavior (Maybe Bool)
behavior_metricDimension :: Lens' Behavior (Maybe MetricDimension)
behavior_metric :: Lens' Behavior (Maybe Text)
behavior_criteria :: Lens' Behavior (Maybe BehaviorCriteria)
behavior_name :: Lens' Behavior Text

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 Methods (==) :: Behavior -> Behavior -> Bool # (/=) :: Behavior -> Behavior -> Bool #
Read Behavior Source #
Instance details Defined in Amazonka.IoT.Types.Behavior Methods readsPrec :: Int -> ReadS Behavior # readList :: ReadS [Behavior] # readPrec :: ReadPrec Behavior # readListPrec :: ReadPrec [Behavior] #
Show Behavior Source #
Instance details Defined in Amazonka.IoT.Types.Behavior Methods showsPrec :: Int -> Behavior -> ShowS # show :: Behavior -> String # showList :: [Behavior] -> ShowS #
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 Methods toJSON :: Behavior -> Value # toEncoding :: Behavior -> Encoding # toJSONList :: [Behavior] -> Value # toEncodingList :: [Behavior] -> Encoding #
FromJSON Behavior Source #
Instance details Defined in Amazonka.IoT.Types.Behavior Methods parseJSON :: Value -> Parser Behavior # parseJSONList :: Value -> Parser [Behavior] #
type Rep Behavior Source #
Instance details Defined in Amazonka.IoT.Types.Behavior type Rep Behavior = D1 ('MetaData "Behavior" "Amazonka.IoT.Types.Behavior" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "Behavior'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "suppressAlerts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "metricDimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricDimension))) :: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "criteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BehaviorCriteria)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newBehavior Source #

Arguments

:: Text	`$sel:name:Behavior'`
-> Behavior

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_suppressAlerts :: Lens' Behavior (Maybe Bool) Source #

Suppresses alerts.

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.