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.TopicRulePayload

Description

Documentation

data TopicRulePayload Source #

Describes a rule.

See: newTopicRulePayload smart constructor.

Constructors

TopicRulePayload'

Fields

awsIotSqlVersion :: Maybe Text
The version of the SQL rules engine to use when evaluating the rule.
errorAction :: Maybe Action
The action to take when an error occurs.
ruleDisabled :: Maybe Bool
Specifies whether the rule is disabled.
description :: Maybe Text
The description of the rule.
sql :: Text
The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.
actions :: [Action]
The actions associated with the rule.

Instances

Instances details

Eq TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload Methods (==) :: TopicRulePayload -> TopicRulePayload -> Bool # (/=) :: TopicRulePayload -> TopicRulePayload -> Bool #
Read TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload Methods readsPrec :: Int -> ReadS TopicRulePayload # readList :: ReadS [TopicRulePayload] # readPrec :: ReadPrec TopicRulePayload # readListPrec :: ReadPrec [TopicRulePayload] #
Show TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload Methods showsPrec :: Int -> TopicRulePayload -> ShowS # show :: TopicRulePayload -> String # showList :: [TopicRulePayload] -> ShowS #
Generic TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload Associated Types type Rep TopicRulePayload :: Type -> Type # Methods from :: TopicRulePayload -> Rep TopicRulePayload x # to :: Rep TopicRulePayload x -> TopicRulePayload #
NFData TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload Methods rnf :: TopicRulePayload -> () #
Hashable TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload Methods hashWithSalt :: Int -> TopicRulePayload -> Int # hash :: TopicRulePayload -> Int #
ToJSON TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload Methods toJSON :: TopicRulePayload -> Value # toEncoding :: TopicRulePayload -> Encoding # toJSONList :: [TopicRulePayload] -> Value # toEncodingList :: [TopicRulePayload] -> Encoding #
type Rep TopicRulePayload Source #
Instance details Defined in Amazonka.IoT.Types.TopicRulePayload type Rep TopicRulePayload = D1 ('MetaData "TopicRulePayload" "Amazonka.IoT.Types.TopicRulePayload" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "TopicRulePayload'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awsIotSqlVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "errorAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :: S1 ('MetaSel ('Just "ruleDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sql") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Action])))))

newTopicRulePayload Source #

Arguments

:: Text	`$sel:sql:TopicRulePayload'`
-> TopicRulePayload

Create a value of TopicRulePayload 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:awsIotSqlVersion:TopicRulePayload', topicRulePayload_awsIotSqlVersion - The version of the SQL rules engine to use when evaluating the rule.

$sel:errorAction:TopicRulePayload', topicRulePayload_errorAction - The action to take when an error occurs.

$sel:ruleDisabled:TopicRulePayload', topicRulePayload_ruleDisabled - Specifies whether the rule is disabled.

$sel:description:TopicRulePayload', topicRulePayload_description - The description of the rule.

$sel:sql:TopicRulePayload', topicRulePayload_sql - The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

$sel:actions:TopicRulePayload', topicRulePayload_actions - The actions associated with the rule.

topicRulePayload_awsIotSqlVersion :: Lens' TopicRulePayload (Maybe Text) Source #

The version of the SQL rules engine to use when evaluating the rule.

topicRulePayload_errorAction :: Lens' TopicRulePayload (Maybe Action) Source #

The action to take when an error occurs.

topicRulePayload_ruleDisabled :: Lens' TopicRulePayload (Maybe Bool) Source #

Specifies whether the rule is disabled.

topicRulePayload_description :: Lens' TopicRulePayload (Maybe Text) Source #

The description of the rule.

topicRulePayload_sql :: Lens' TopicRulePayload Text Source #

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

topicRulePayload_actions :: Lens' TopicRulePayload [Action] Source #

The actions associated with the rule.