| 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.WAFRegional.UpdateRuleGroup
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 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
Rulesthat you want to include in theRuleGroup. See CreateRule. - Use
GetChangeTokento get the change token that you provide in theChangeTokenparameter of an UpdateRuleGroup request. - Submit an
UpdateRuleGrouprequest to addRulesto theRuleGroup. - Create and update a
WebACLthat contains theRuleGroup. 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.
Synopsis
- data UpdateRuleGroup = UpdateRuleGroup' {}
- newUpdateRuleGroup :: Text -> NonEmpty RuleGroupUpdate -> Text -> UpdateRuleGroup
- updateRuleGroup_ruleGroupId :: Lens' UpdateRuleGroup Text
- updateRuleGroup_updates :: Lens' UpdateRuleGroup (NonEmpty RuleGroupUpdate)
- updateRuleGroup_changeToken :: Lens' UpdateRuleGroup Text
- data UpdateRuleGroupResponse = UpdateRuleGroupResponse' {
- changeToken :: Maybe Text
- httpStatus :: Int
- newUpdateRuleGroupResponse :: Int -> UpdateRuleGroupResponse
- updateRuleGroupResponse_changeToken :: Lens' UpdateRuleGroupResponse (Maybe Text)
- updateRuleGroupResponse_httpStatus :: Lens' UpdateRuleGroupResponse Int
Creating a Request
data UpdateRuleGroup Source #
See: newUpdateRuleGroup smart constructor.
Constructors
| UpdateRuleGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty RuleGroupUpdate | |
| -> Text | |
| -> UpdateRuleGroup |
Create a value of UpdateRuleGroup 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:ruleGroupId:UpdateRuleGroup', updateRuleGroup_ruleGroupId - The RuleGroupId of the RuleGroup that you want to update.
RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
$sel:updates:UpdateRuleGroup', updateRuleGroup_updates - 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.
$sel:changeToken:UpdateRuleGroup', updateRuleGroup_changeToken - The value returned by the most recent call to GetChangeToken.
Request Lenses
updateRuleGroup_ruleGroupId :: Lens' UpdateRuleGroup Text Source #
The RuleGroupId of the RuleGroup that you want to update.
RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
updateRuleGroup_updates :: Lens' UpdateRuleGroup (NonEmpty RuleGroupUpdate) Source #
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.
updateRuleGroup_changeToken :: Lens' UpdateRuleGroup Text Source #
The value returned by the most recent call to GetChangeToken.
Destructuring the Response
data UpdateRuleGroupResponse Source #
See: newUpdateRuleGroupResponse smart constructor.
Constructors
| UpdateRuleGroupResponse' | |
Fields
| |
Instances
newUpdateRuleGroupResponse Source #
Create a value of UpdateRuleGroupResponse 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:changeToken:UpdateRuleGroup', updateRuleGroupResponse_changeToken - 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.
$sel:httpStatus:UpdateRuleGroupResponse', updateRuleGroupResponse_httpStatus - The response's http status code.
Response Lenses
updateRuleGroupResponse_changeToken :: Lens' UpdateRuleGroupResponse (Maybe Text) Source #
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.
updateRuleGroupResponse_httpStatus :: Lens' UpdateRuleGroupResponse Int Source #
The response's http status code.