Amazonka.CloudWatch.Types.InsightRule

Documentation

data InsightRule

This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.

See: newInsightRule smart constructor.

Constructors

InsightRule'

Fields

• managedRule :: Maybe Bool

  An optional built-in rule that Amazon Web Services manages.

• name :: Text

  The name of the rule.

• state :: Text

  Indicates whether the rule is enabled or disabled.

• schema :: Text

  For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

• definition :: Text

  The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.

Instances

FromXML InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

Methods

parseXML :: [Node] -> Either String InsightRule

Generic InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

Associated Types

type Rep InsightRule :: Type -> Type

Methods

from :: InsightRule -> Rep InsightRule x

to :: Rep InsightRule x -> InsightRule

Read InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

Methods

readsPrec :: Int -> ReadS InsightRule

readList :: ReadS [InsightRule]

readPrec :: ReadPrec InsightRule

readListPrec :: ReadPrec [InsightRule]

Show InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

Methods

showsPrec :: Int -> InsightRule -> ShowS

show :: InsightRule -> String

showList :: [InsightRule] -> ShowS

NFData InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

Methods

rnf :: InsightRule -> ()

Eq InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

Methods

(==) :: InsightRule -> InsightRule -> Bool

(/=) :: InsightRule -> InsightRule -> Bool

Hashable InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

Methods

hashWithSalt :: Int -> InsightRule -> Int

hash :: InsightRule -> Int

type Rep InsightRule

Defined in Amazonka.CloudWatch.Types.InsightRule

type Rep InsightRule = D1 ('MetaData "InsightRule" "Amazonka.CloudWatch.Types.InsightRule" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "InsightRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "managedRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newInsightRule

Arguments

:: Text

$sel:name:InsightRule'

-> Text

$sel:state:InsightRule'

-> Text

$sel:schema:InsightRule'

-> Text

$sel:definition:InsightRule'

-> InsightRule

Create a value of InsightRule 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:managedRule:InsightRule', insightRule_managedRule - An optional built-in rule that Amazon Web Services manages.

$sel:name:InsightRule', insightRule_name - The name of the rule.

$sel:state:InsightRule', insightRule_state - Indicates whether the rule is enabled or disabled.

$sel:schema:InsightRule', insightRule_schema - For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

$sel:definition:InsightRule', insightRule_definition - The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.

insightRule_managedRule :: Lens' InsightRule (Maybe Bool)

An optional built-in rule that Amazon Web Services manages.

insightRule_name :: Lens' InsightRule Text

The name of the rule.

insightRule_state :: Lens' InsightRule Text

Indicates whether the rule is enabled or disabled.

insightRule_schema :: Lens' InsightRule Text

For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

insightRule_definition :: Lens' InsightRule Text

The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.