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

Description

Documentation

data RuleGroup Source #

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

See: newRuleGroup smart constructor.

Constructors

RuleGroup'

Fields

referenceSets :: Maybe ReferenceSets
The list of a rule group's reference sets.
ruleVariables :: Maybe RuleVariables
Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
statefulRuleOptions :: Maybe StatefulRuleOptions
Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
rulesSource :: RulesSource
The stateful rules or stateless rules for the rule group.

Instances

Instances details

FromJSON RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.RuleGroup Methods parseJSON :: Value -> Parser RuleGroup # parseJSONList :: Value -> Parser [RuleGroup] #
ToJSON RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.RuleGroup Methods toJSON :: RuleGroup -> Value # toEncoding :: RuleGroup -> Encoding # toJSONList :: [RuleGroup] -> Value # toEncodingList :: [RuleGroup] -> Encoding #
Generic RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.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.NetworkFirewall.Types.RuleGroup Methods readsPrec :: Int -> ReadS RuleGroup # readList :: ReadS [RuleGroup] # readPrec :: ReadPrec RuleGroup # readListPrec :: ReadPrec [RuleGroup] #
Show RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.RuleGroup Methods showsPrec :: Int -> RuleGroup -> ShowS # show :: RuleGroup -> String # showList :: [RuleGroup] -> ShowS #
NFData RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.RuleGroup Methods rnf :: RuleGroup -> () #
Eq RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.RuleGroup Methods (==) :: RuleGroup -> RuleGroup -> Bool # (/=) :: RuleGroup -> RuleGroup -> Bool #
Hashable RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.RuleGroup Methods hashWithSalt :: Int -> RuleGroup -> Int # hash :: RuleGroup -> Int #
type Rep RuleGroup Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.RuleGroup type Rep RuleGroup = D1 ('MetaData "RuleGroup" "Amazonka.NetworkFirewall.Types.RuleGroup" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "RuleGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "referenceSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReferenceSets)) :: S1 ('MetaSel ('Just "ruleVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleVariables))) :: (S1 ('MetaSel ('Just "statefulRuleOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatefulRuleOptions)) :*: S1 ('MetaSel ('Just "rulesSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RulesSource))))

newRuleGroup Source #

Arguments

:: RulesSource	`$sel:rulesSource: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:referenceSets:RuleGroup', ruleGroup_referenceSets - The list of a rule group's reference sets.

$sel:ruleVariables:RuleGroup', ruleGroup_ruleVariables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.

$sel:statefulRuleOptions:RuleGroup', ruleGroup_statefulRuleOptions - Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.

$sel:rulesSource:RuleGroup', ruleGroup_rulesSource - The stateful rules or stateless rules for the rule group.

ruleGroup_referenceSets :: Lens' RuleGroup (Maybe ReferenceSets) Source #

The list of a rule group's reference sets.

ruleGroup_ruleVariables :: Lens' RuleGroup (Maybe RuleVariables) Source #

Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.

ruleGroup_statefulRuleOptions :: Lens' RuleGroup (Maybe StatefulRuleOptions) Source #

Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.

ruleGroup_rulesSource :: Lens' RuleGroup RulesSource Source #

The stateful rules or stateless rules for the rule group.