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.WAF.Types.Rule

Description

Synopsis

data Rule = Rule' {
- metricName :: Maybe Text
- name :: Maybe Text
- ruleId :: Text
- predicates :: [Predicate]
}
newRule :: Text -> Rule
rule_metricName :: Lens' Rule (Maybe Text)
rule_name :: Lens' Rule (Maybe Text)
rule_ruleId :: Lens' Rule Text
rule_predicates :: Lens' Rule [Predicate]

Documentation

data Rule Source #

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.

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

See: newRule smart constructor.

Constructors

Rule'

Fields

metricName :: Maybe Text
A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
name :: Maybe Text
The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
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 a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by ListRules.
predicates :: [Predicate]
The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Instances

Instances details

Eq Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule Methods (==) :: Rule -> Rule -> Bool # (/=) :: Rule -> Rule -> Bool #
Read Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule Methods readsPrec :: Int -> ReadS Rule # readList :: ReadS [Rule] # readPrec :: ReadPrec Rule # readListPrec :: ReadPrec [Rule] #
Show Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule Methods showsPrec :: Int -> Rule -> ShowS # show :: Rule -> String # showList :: [Rule] -> ShowS #
Generic Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule Associated Types type Rep Rule :: Type -> Type # Methods from :: Rule -> Rep Rule x # to :: Rep Rule x -> Rule #
NFData Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule Methods rnf :: Rule -> () #
Hashable Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule Methods hashWithSalt :: Int -> Rule -> Int # hash :: Rule -> Int #
FromJSON Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule Methods parseJSON :: Value -> Parser Rule # parseJSONList :: Value -> Parser [Rule] #
type Rep Rule Source #
Instance details Defined in Amazonka.WAF.Types.Rule type Rep Rule = D1 ('MetaData "Rule" "Amazonka.WAF.Types.Rule" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "Rule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "predicates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Predicate]))))

newRule Source #

Arguments

:: Text	`$sel:ruleId:Rule'`
-> Rule

Create a value of Rule 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:metricName:Rule', rule_metricName - A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

$sel:name:Rule', rule_name - The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

$sel:ruleId:Rule', rule_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 a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

$sel:predicates:Rule', rule_predicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

rule_metricName :: Lens' Rule (Maybe Text) Source #

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

rule_name :: Lens' Rule (Maybe Text) Source #

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

rule_ruleId :: Lens' Rule Text Source #

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 a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

rule_predicates :: Lens' Rule [Predicate] Source #

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.