| 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.WAF.UpdateRegexMatchSet
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 RegexMatchTuple objects (filters) in a RegexMatchSet.
For each RegexMatchSetUpdate object, you specify the following values:
- Whether to insert or delete the object from the array. If you want
to change a
RegexMatchSetUpdateobject, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to inspectupdate,
such as a query string or the value of the
User-Agentheader. - The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
- Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a RegexPatternSet that matches any
requests with User-Agent headers that contain the string
B[a@]dB[o0]t. You can then configure AWS WAF to reject those
requests.
To create and configure a RegexMatchSet, perform the following steps:
- Create a
RegexMatchSet.For more information, see CreateRegexMatchSet. - Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of anUpdateRegexMatchSetrequest. - Submit an
UpdateRegexMatchSetrequest to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of theRegexPatternSetthat contain the regular expression patters you want AWS WAF to watch for.
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 UpdateRegexMatchSet = UpdateRegexMatchSet' {}
- newUpdateRegexMatchSet :: Text -> NonEmpty RegexMatchSetUpdate -> Text -> UpdateRegexMatchSet
- updateRegexMatchSet_regexMatchSetId :: Lens' UpdateRegexMatchSet Text
- updateRegexMatchSet_updates :: Lens' UpdateRegexMatchSet (NonEmpty RegexMatchSetUpdate)
- updateRegexMatchSet_changeToken :: Lens' UpdateRegexMatchSet Text
- data UpdateRegexMatchSetResponse = UpdateRegexMatchSetResponse' {
- changeToken :: Maybe Text
- httpStatus :: Int
- newUpdateRegexMatchSetResponse :: Int -> UpdateRegexMatchSetResponse
- updateRegexMatchSetResponse_changeToken :: Lens' UpdateRegexMatchSetResponse (Maybe Text)
- updateRegexMatchSetResponse_httpStatus :: Lens' UpdateRegexMatchSetResponse Int
Creating a Request
data UpdateRegexMatchSet Source #
See: newUpdateRegexMatchSet smart constructor.
Constructors
| UpdateRegexMatchSet' | |
Fields
| |
Instances
newUpdateRegexMatchSet Source #
Arguments
| :: Text | |
| -> NonEmpty RegexMatchSetUpdate | |
| -> Text | |
| -> UpdateRegexMatchSet |
Create a value of UpdateRegexMatchSet 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:regexMatchSetId:UpdateRegexMatchSet', updateRegexMatchSet_regexMatchSetId - The RegexMatchSetId of the RegexMatchSet that you want to update.
RegexMatchSetId is returned by CreateRegexMatchSet and by
ListRegexMatchSets.
$sel:updates:UpdateRegexMatchSet', updateRegexMatchSet_updates - An array of RegexMatchSetUpdate objects that you want to insert into
or delete from a RegexMatchSet. For more information, see
RegexMatchTuple.
$sel:changeToken:UpdateRegexMatchSet', updateRegexMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.
Request Lenses
updateRegexMatchSet_regexMatchSetId :: Lens' UpdateRegexMatchSet Text Source #
The RegexMatchSetId of the RegexMatchSet that you want to update.
RegexMatchSetId is returned by CreateRegexMatchSet and by
ListRegexMatchSets.
updateRegexMatchSet_updates :: Lens' UpdateRegexMatchSet (NonEmpty RegexMatchSetUpdate) Source #
An array of RegexMatchSetUpdate objects that you want to insert into
or delete from a RegexMatchSet. For more information, see
RegexMatchTuple.
updateRegexMatchSet_changeToken :: Lens' UpdateRegexMatchSet Text Source #
The value returned by the most recent call to GetChangeToken.
Destructuring the Response
data UpdateRegexMatchSetResponse Source #
See: newUpdateRegexMatchSetResponse smart constructor.
Constructors
| UpdateRegexMatchSetResponse' | |
Fields
| |
Instances
newUpdateRegexMatchSetResponse Source #
Create a value of UpdateRegexMatchSetResponse 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:UpdateRegexMatchSet', updateRegexMatchSetResponse_changeToken - The ChangeToken that you used to submit the UpdateRegexMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
$sel:httpStatus:UpdateRegexMatchSetResponse', updateRegexMatchSetResponse_httpStatus - The response's http status code.
Response Lenses
updateRegexMatchSetResponse_changeToken :: Lens' UpdateRegexMatchSetResponse (Maybe Text) Source #
The ChangeToken that you used to submit the UpdateRegexMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
updateRegexMatchSetResponse_httpStatus :: Lens' UpdateRegexMatchSetResponse Int Source #
The response's http status code.