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.WAF.UpdateWebACL

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.
The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.
For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.
The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

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

Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
Create a WebACL. See CreateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.
The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule , you can exclude specific rules from that rule group.
If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules .

Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

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

data UpdateWebACL Source #

See: newUpdateWebACL smart constructor.

Constructors

UpdateWebACL'

Fields

defaultAction :: Maybe WafAction
A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.
updates :: Maybe [WebACLUpdate]
An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:
- WebACLUpdate: Contains Action and ActivatedRule
- ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. 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.
- WafAction: Contains Type
webACLId :: Text
The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.
changeToken :: Text
The value returned by the most recent call to GetChangeToken.

Instances

Instances details

ToJSON UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods toJSON :: UpdateWebACL -> Value # toEncoding :: UpdateWebACL -> Encoding # toJSONList :: [UpdateWebACL] -> Value # toEncodingList :: [UpdateWebACL] -> Encoding #
ToHeaders UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods toHeaders :: UpdateWebACL -> [Header] #
ToPath UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods toPath :: UpdateWebACL -> ByteString #
ToQuery UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods toQuery :: UpdateWebACL -> QueryString #
AWSRequest UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Associated Types type AWSResponse UpdateWebACL # Methods request :: (Service -> Service) -> UpdateWebACL -> Request UpdateWebACL # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateWebACL -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateWebACL))) #
Generic UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Associated Types type Rep UpdateWebACL :: Type -> Type # Methods from :: UpdateWebACL -> Rep UpdateWebACL x # to :: Rep UpdateWebACL x -> UpdateWebACL #
Read UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods readsPrec :: Int -> ReadS UpdateWebACL # readList :: ReadS [UpdateWebACL] # readPrec :: ReadPrec UpdateWebACL # readListPrec :: ReadPrec [UpdateWebACL] #
Show UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods showsPrec :: Int -> UpdateWebACL -> ShowS # show :: UpdateWebACL -> String # showList :: [UpdateWebACL] -> ShowS #
NFData UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods rnf :: UpdateWebACL -> () #
Eq UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods (==) :: UpdateWebACL -> UpdateWebACL -> Bool # (/=) :: UpdateWebACL -> UpdateWebACL -> Bool #
Hashable UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods hashWithSalt :: Int -> UpdateWebACL -> Int # hash :: UpdateWebACL -> Int #
type AWSResponse UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL type AWSResponse UpdateWebACL = UpdateWebACLResponse
type Rep UpdateWebACL Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL type Rep UpdateWebACL = D1 ('MetaData "UpdateWebACL" "Amazonka.WAF.UpdateWebACL" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "UpdateWebACL'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WafAction)) :: S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WebACLUpdate]))) :: (S1 ('MetaSel ('Just "webACLId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateWebACL Source #

Arguments

:: Text	`UpdateWebACL`
-> Text	`UpdateWebACL`
-> UpdateWebACL

Create a value of UpdateWebACL 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:

UpdateWebACL, updateWebACL_defaultAction - A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

$sel:updates:UpdateWebACL', updateWebACL_updates - An array of updates to make to the WebACL.

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. 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.
WafAction: Contains Type

UpdateWebACL, updateWebACL_webACLId - The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

UpdateWebACL, updateWebACL_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

updateWebACL_defaultAction :: Lens' UpdateWebACL (Maybe WafAction) Source #

A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

updateWebACL_updates :: Lens' UpdateWebACL (Maybe [WebACLUpdate]) Source #

An array of updates to make to the WebACL.

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. 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.
WafAction: Contains Type

updateWebACL_webACLId :: Lens' UpdateWebACL Text Source #

The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

updateWebACL_changeToken :: Lens' UpdateWebACL Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data UpdateWebACLResponse Source #

See: newUpdateWebACLResponse smart constructor.

Constructors

UpdateWebACLResponse'
Fields changeToken :: Maybe Text The `ChangeToken` that you used to submit the `UpdateWebACL` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateWebACLResponse Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Associated Types type Rep UpdateWebACLResponse :: Type -> Type # Methods from :: UpdateWebACLResponse -> Rep UpdateWebACLResponse x # to :: Rep UpdateWebACLResponse x -> UpdateWebACLResponse #
Read UpdateWebACLResponse Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods readsPrec :: Int -> ReadS UpdateWebACLResponse # readList :: ReadS [UpdateWebACLResponse] # readPrec :: ReadPrec UpdateWebACLResponse # readListPrec :: ReadPrec [UpdateWebACLResponse] #
Show UpdateWebACLResponse Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods showsPrec :: Int -> UpdateWebACLResponse -> ShowS # show :: UpdateWebACLResponse -> String # showList :: [UpdateWebACLResponse] -> ShowS #
NFData UpdateWebACLResponse Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods rnf :: UpdateWebACLResponse -> () #
Eq UpdateWebACLResponse Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL Methods (==) :: UpdateWebACLResponse -> UpdateWebACLResponse -> Bool # (/=) :: UpdateWebACLResponse -> UpdateWebACLResponse -> Bool #
type Rep UpdateWebACLResponse Source #
Instance details Defined in Amazonka.WAF.UpdateWebACL type Rep UpdateWebACLResponse = D1 ('MetaData "UpdateWebACLResponse" "Amazonka.WAF.UpdateWebACL" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "UpdateWebACLResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateWebACLResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateWebACLResponse'`
-> UpdateWebACLResponse

Create a value of UpdateWebACLResponse 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:

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

$sel:httpStatus:UpdateWebACLResponse', updateWebACLResponse_httpStatus - The response's http status code.

Response Lenses

updateWebACLResponse_changeToken :: Lens' UpdateWebACLResponse (Maybe Text) Source #

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

updateWebACLResponse_httpStatus :: Lens' UpdateWebACLResponse Int Source #

The response's http status code.