Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT.Types.TopicRule

Description

Synopsis

data TopicRule = TopicRule' {
- actions :: Maybe [Action]
- awsIotSqlVersion :: Maybe Text
- createdAt :: Maybe POSIX
- description :: Maybe Text
- errorAction :: Maybe Action
- ruleDisabled :: Maybe Bool
- ruleName :: Maybe Text
- sql :: Maybe Text
}
newTopicRule :: TopicRule
topicRule_actions :: Lens' TopicRule (Maybe [Action])
topicRule_awsIotSqlVersion :: Lens' TopicRule (Maybe Text)
topicRule_createdAt :: Lens' TopicRule (Maybe UTCTime)
topicRule_description :: Lens' TopicRule (Maybe Text)
topicRule_errorAction :: Lens' TopicRule (Maybe Action)
topicRule_ruleDisabled :: Lens' TopicRule (Maybe Bool)
topicRule_ruleName :: Lens' TopicRule (Maybe Text)
topicRule_sql :: Lens' TopicRule (Maybe Text)

Documentation

data TopicRule Source #

Describes a rule.

See: newTopicRule smart constructor.

Constructors

TopicRule'

Fields

actions :: Maybe [Action]
The actions associated with the rule.
awsIotSqlVersion :: Maybe Text
The version of the SQL rules engine to use when evaluating the rule.
createdAt :: Maybe POSIX
The date and time the rule was created.
description :: Maybe Text
The description of the rule.
errorAction :: Maybe Action
The action to perform when an error occurs.
ruleDisabled :: Maybe Bool
Specifies whether the rule is disabled.
ruleName :: Maybe Text
The name of the rule.
sql :: Maybe Text
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Instances

Instances details

FromJSON TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule Methods parseJSON :: Value -> Parser TopicRule # parseJSONList :: Value -> Parser [TopicRule] #
Generic TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule Associated Types type Rep TopicRule :: Type -> Type # Methods from :: TopicRule -> Rep TopicRule x # to :: Rep TopicRule x -> TopicRule #
Read TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule Methods readsPrec :: Int -> ReadS TopicRule # readList :: ReadS [TopicRule] # readPrec :: ReadPrec TopicRule # readListPrec :: ReadPrec [TopicRule] #
Show TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule Methods showsPrec :: Int -> TopicRule -> ShowS # show :: TopicRule -> String # showList :: [TopicRule] -> ShowS #
NFData TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule Methods rnf :: TopicRule -> () #
Eq TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule Methods (==) :: TopicRule -> TopicRule -> Bool # (/=) :: TopicRule -> TopicRule -> Bool #
Hashable TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule Methods hashWithSalt :: Int -> TopicRule -> Int # hash :: TopicRule -> Int #
type Rep TopicRule Source #
Instance details Defined in Amazonka.IoT.Types.TopicRule type Rep TopicRule = D1 ('MetaData "TopicRule" "Amazonka.IoT.Types.TopicRule" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "TopicRule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Action])) :: S1 ('MetaSel ('Just "awsIotSqlVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") '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 "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sql") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newTopicRule :: TopicRule Source #

Create a value of TopicRule 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:actions:TopicRule', topicRule_actions - The actions associated with the rule.

$sel:awsIotSqlVersion:TopicRule', topicRule_awsIotSqlVersion - The version of the SQL rules engine to use when evaluating the rule.

$sel:createdAt:TopicRule', topicRule_createdAt - The date and time the rule was created.

$sel:description:TopicRule', topicRule_description - The description of the rule.

$sel:errorAction:TopicRule', topicRule_errorAction - The action to perform when an error occurs.

$sel:ruleDisabled:TopicRule', topicRule_ruleDisabled - Specifies whether the rule is disabled.

$sel:ruleName:TopicRule', topicRule_ruleName - The name of the rule.

$sel:sql:TopicRule', topicRule_sql - The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

topicRule_actions :: Lens' TopicRule (Maybe [Action]) Source #

The actions associated with the rule.

topicRule_awsIotSqlVersion :: Lens' TopicRule (Maybe Text) Source #

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

topicRule_createdAt :: Lens' TopicRule (Maybe UTCTime) Source #

The date and time the rule was created.

topicRule_description :: Lens' TopicRule (Maybe Text) Source #

The description of the rule.

topicRule_errorAction :: Lens' TopicRule (Maybe Action) Source #

The action to perform when an error occurs.

topicRule_ruleDisabled :: Lens' TopicRule (Maybe Bool) Source #

Specifies whether the rule is disabled.

topicRule_ruleName :: Lens' TopicRule (Maybe Text) Source #

The name of the rule.

topicRule_sql :: Lens' TopicRule (Maybe Text) Source #

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.