Network.AWS.WAF.UpdateRuleGroup

Inserts or deletes ActivatedRule objects in a RuleGroup .

You can only insert REGULAR rules into a rule group.

You can have a maximum of ten rules per rule group.

To create and configure a RuleGroup , perform the following steps:

• Create and update the Rules that you want to include in the RuleGroup . See CreateRule .
• Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.
• Submit an UpdateRuleGroup request to add Rules to the RuleGroup .
• Create and update a WebACL that contains the RuleGroup . See CreateWebACL .

If you want to replace one Rule with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide .

Creating a Request

updateRuleGroup

Arguments

:: Text

urgRuleGroupId

-> NonEmpty RuleGroupUpdate

urgUpdates

-> Text

urgChangeToken

-> UpdateRuleGroup

Creates a value of UpdateRuleGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• urgRuleGroupId - The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups .
• urgUpdates - An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup . You can only insert REGULAR rules into a rule group. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL . In this case you do not use ActivatedRule|Action . For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction .
• urgChangeToken - The value returned by the most recent call to GetChangeToken .

data UpdateRuleGroup

See: updateRuleGroup smart constructor.

Instances

Eq UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

(==) :: UpdateRuleGroup -> UpdateRuleGroup -> Bool

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

Data UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateRuleGroup -> c UpdateRuleGroup

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateRuleGroup

toConstr :: UpdateRuleGroup -> Constr

dataTypeOf :: UpdateRuleGroup -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateRuleGroup)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateRuleGroup)

gmapT :: (forall b. Data b => b -> b) -> UpdateRuleGroup -> UpdateRuleGroup

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuleGroup -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuleGroup -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateRuleGroup -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateRuleGroup -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateRuleGroup -> m UpdateRuleGroup

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuleGroup -> m UpdateRuleGroup

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuleGroup -> m UpdateRuleGroup

Read UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

readsPrec :: Int -> ReadS UpdateRuleGroup

readList :: ReadS [UpdateRuleGroup]

readPrec :: ReadPrec UpdateRuleGroup

readListPrec :: ReadPrec [UpdateRuleGroup]

Show UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

showsPrec :: Int -> UpdateRuleGroup -> ShowS

show :: UpdateRuleGroup -> String

showList :: [UpdateRuleGroup] -> ShowS

Generic UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Associated Types

type Rep UpdateRuleGroup :: Type -> Type

Methods

from :: UpdateRuleGroup -> Rep UpdateRuleGroup x

to :: Rep UpdateRuleGroup x -> UpdateRuleGroup

Hashable UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

hashWithSalt :: Int -> UpdateRuleGroup -> Int

hash :: UpdateRuleGroup -> Int

ToJSON UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

toJSON :: UpdateRuleGroup -> Value

toEncoding :: UpdateRuleGroup -> Encoding

toJSONList :: [UpdateRuleGroup] -> Value

toEncodingList :: [UpdateRuleGroup] -> Encoding

AWSRequest UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Associated Types

type Rs UpdateRuleGroup :: Type

Methods

request :: UpdateRuleGroup -> Request UpdateRuleGroup

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateRuleGroup -> ClientResponse -> m (Response UpdateRuleGroup)

ToHeaders UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

toHeaders :: UpdateRuleGroup -> [Header]

ToPath UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

toPath :: UpdateRuleGroup -> ByteString

ToQuery UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

toQuery :: UpdateRuleGroup -> QueryString

NFData UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

rnf :: UpdateRuleGroup -> ()

type Rep UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

type Rep UpdateRuleGroup = D1 (MetaData "UpdateRuleGroup" "Network.AWS.WAF.UpdateRuleGroup" "amazonka-waf-1.6.1-AAUMqlxoZ2N3dlHnZE2nzz" False) (C1 (MetaCons "UpdateRuleGroup'" PrefixI True) (S1 (MetaSel (Just "_urgRuleGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_urgUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 RuleGroupUpdate)) :*: S1 (MetaSel (Just "_urgChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateRuleGroup

Defined in Network.AWS.WAF.UpdateRuleGroup

type Rs UpdateRuleGroup = UpdateRuleGroupResponse

Request Lenses

urgRuleGroupId :: Lens' UpdateRuleGroup Text

The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups .

urgUpdates :: Lens' UpdateRuleGroup (NonEmpty RuleGroupUpdate)

An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup . You can only insert REGULAR rules into a rule group. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL . In this case you do not use ActivatedRule|Action . For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction .

urgChangeToken :: Lens' UpdateRuleGroup Text

The value returned by the most recent call to GetChangeToken .

Destructuring the Response

updateRuleGroupResponse

Arguments

:: Int

urgrsResponseStatus

-> UpdateRuleGroupResponse

Creates a value of UpdateRuleGroupResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• urgrsChangeToken - The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .
• urgrsResponseStatus - -- | The response status code.

data UpdateRuleGroupResponse

See: updateRuleGroupResponse smart constructor.

Instances

Eq UpdateRuleGroupResponse

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

(==) :: UpdateRuleGroupResponse -> UpdateRuleGroupResponse -> Bool

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

Data UpdateRuleGroupResponse

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateRuleGroupResponse -> c UpdateRuleGroupResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateRuleGroupResponse

toConstr :: UpdateRuleGroupResponse -> Constr

dataTypeOf :: UpdateRuleGroupResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateRuleGroupResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateRuleGroupResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateRuleGroupResponse -> UpdateRuleGroupResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuleGroupResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuleGroupResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateRuleGroupResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateRuleGroupResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateRuleGroupResponse -> m UpdateRuleGroupResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuleGroupResponse -> m UpdateRuleGroupResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuleGroupResponse -> m UpdateRuleGroupResponse

Read UpdateRuleGroupResponse

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

readsPrec :: Int -> ReadS UpdateRuleGroupResponse

readList :: ReadS [UpdateRuleGroupResponse]

readPrec :: ReadPrec UpdateRuleGroupResponse

readListPrec :: ReadPrec [UpdateRuleGroupResponse]

Show UpdateRuleGroupResponse

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

showsPrec :: Int -> UpdateRuleGroupResponse -> ShowS

show :: UpdateRuleGroupResponse -> String

showList :: [UpdateRuleGroupResponse] -> ShowS

Generic UpdateRuleGroupResponse

Defined in Network.AWS.WAF.UpdateRuleGroup

Associated Types

type Rep UpdateRuleGroupResponse :: Type -> Type

Methods

from :: UpdateRuleGroupResponse -> Rep UpdateRuleGroupResponse x

to :: Rep UpdateRuleGroupResponse x -> UpdateRuleGroupResponse

NFData UpdateRuleGroupResponse

Defined in Network.AWS.WAF.UpdateRuleGroup

Methods

rnf :: UpdateRuleGroupResponse -> ()

type Rep UpdateRuleGroupResponse

Defined in Network.AWS.WAF.UpdateRuleGroup

type Rep UpdateRuleGroupResponse = D1 (MetaData "UpdateRuleGroupResponse" "Network.AWS.WAF.UpdateRuleGroup" "amazonka-waf-1.6.1-AAUMqlxoZ2N3dlHnZE2nzz" False) (C1 (MetaCons "UpdateRuleGroupResponse'" PrefixI True) (S1 (MetaSel (Just "_urgrsChangeToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_urgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

urgrsChangeToken :: Lens' UpdateRuleGroupResponse (Maybe Text)

The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .

urgrsResponseStatus :: Lens' UpdateRuleGroupResponse Int

• - | The response status code.