Amazonka.WAFRegional.Types.RuleSummary

Documentation

data RuleSummary

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the Rule.

See: newRuleSummary smart constructor.

Constructors

RuleSummary'

Fields

• ruleId :: Text

  A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

  RuleId is returned by CreateRule and by ListRules.

• name :: Text

  A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

Instances

FromJSON RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

Methods

parseJSON :: Value -> Parser RuleSummary

parseJSONList :: Value -> Parser [RuleSummary]

Generic RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

Associated Types

type Rep RuleSummary :: Type -> Type

Methods

from :: RuleSummary -> Rep RuleSummary x

to :: Rep RuleSummary x -> RuleSummary

Read RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

Methods

readsPrec :: Int -> ReadS RuleSummary

readList :: ReadS [RuleSummary]

readPrec :: ReadPrec RuleSummary

readListPrec :: ReadPrec [RuleSummary]

Show RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

Methods

showsPrec :: Int -> RuleSummary -> ShowS

show :: RuleSummary -> String

showList :: [RuleSummary] -> ShowS

NFData RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

Methods

rnf :: RuleSummary -> ()

Eq RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

Methods

(==) :: RuleSummary -> RuleSummary -> Bool

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

Hashable RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

Methods

hashWithSalt :: Int -> RuleSummary -> Int

hash :: RuleSummary -> Int

type Rep RuleSummary

Defined in Amazonka.WAFRegional.Types.RuleSummary

type Rep RuleSummary = D1 ('MetaData "RuleSummary" "Amazonka.WAFRegional.Types.RuleSummary" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "RuleSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRuleSummary

Arguments

:: Text

$sel:ruleId:RuleSummary'

-> Text

$sel:name:RuleSummary'

-> RuleSummary

Create a value of RuleSummary 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:ruleId:RuleSummary', ruleSummary_ruleId - A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

$sel:name:RuleSummary', ruleSummary_name - A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

ruleSummary_ruleId :: Lens' RuleSummary Text

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

ruleSummary_name :: Lens' RuleSummary Text

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.