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.WAFRegional.Types.RuleGroup

Description

Synopsis

data RuleGroup = RuleGroup' {
- metricName :: Maybe Text
- name :: Maybe Text
- ruleGroupId :: Text
}
newRuleGroup :: Text -> RuleGroup
ruleGroup_metricName :: Lens' RuleGroup (Maybe Text)
ruleGroup_name :: Lens' RuleGroup (Maybe Text)
ruleGroup_ruleGroupId :: Lens' RuleGroup Text

Documentation

data RuleGroup 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 collection of predefined rules that you can add to a web ACL.

Rule groups are subject to the following limits:

Three rule groups per account. You can request an increase to this limit by contacting customer support.
One rule group per web ACL.
Ten rules per rule group.

See: newRuleGroup smart constructor.

Constructors

RuleGroup'

Fields

metricName :: Maybe Text
A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.
name :: Maybe Text
The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.
ruleGroupId :: Text
A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Instances

Instances details

FromJSON RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup Methods parseJSON :: Value -> Parser RuleGroup # parseJSONList :: Value -> Parser [RuleGroup] #
Generic RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup Associated Types type Rep RuleGroup :: Type -> Type # Methods from :: RuleGroup -> Rep RuleGroup x # to :: Rep RuleGroup x -> RuleGroup #
Read RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup Methods readsPrec :: Int -> ReadS RuleGroup # readList :: ReadS [RuleGroup] # readPrec :: ReadPrec RuleGroup # readListPrec :: ReadPrec [RuleGroup] #
Show RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup Methods showsPrec :: Int -> RuleGroup -> ShowS # show :: RuleGroup -> String # showList :: [RuleGroup] -> ShowS #
NFData RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup Methods rnf :: RuleGroup -> () #
Eq RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup Methods (==) :: RuleGroup -> RuleGroup -> Bool # (/=) :: RuleGroup -> RuleGroup -> Bool #
Hashable RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup Methods hashWithSalt :: Int -> RuleGroup -> Int # hash :: RuleGroup -> Int #
type Rep RuleGroup Source #
Instance details Defined in Amazonka.WAFRegional.Types.RuleGroup type Rep RuleGroup = D1 ('MetaData "RuleGroup" "Amazonka.WAFRegional.Types.RuleGroup" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "RuleGroup'" '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 "ruleGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newRuleGroup Source #

Arguments

:: Text	`$sel:ruleGroupId:RuleGroup'`
-> RuleGroup

Create a value of RuleGroup 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:RuleGroup', ruleGroup_metricName - A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

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

$sel:ruleGroupId:RuleGroup', ruleGroup_ruleGroupId - A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

ruleGroup_metricName :: Lens' RuleGroup (Maybe Text) Source #

A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

ruleGroup_name :: Lens' RuleGroup (Maybe Text) Source #

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

ruleGroup_ruleGroupId :: Lens' RuleGroup Text Source #

A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.