| 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.UpdateXssMatchSet
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 XssMatchTuple objects (filters) in an XssMatchSet.
For each XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change anXssMatchTuple, you delete the existing object and add a new one.FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.You can only specify a single type of TextTransformation.
You use XssMatchSet objects to specify which CloudFront requests that
you want to allow, block, or count. For example, if you're receiving
requests that contain cross-site scripting attacks in the request body
and you want to block the requests, you can create an XssMatchSet with
the applicable settings, and then configure AWS WAF to block the
requests.
To create and configure an XssMatchSet, perform the following steps:
- Submit a CreateXssMatchSet request.
- Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of an UpdateIPSet request. - Submit an
UpdateXssMatchSetrequest to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
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 UpdateXssMatchSet = UpdateXssMatchSet' {}
- newUpdateXssMatchSet :: Text -> Text -> NonEmpty XssMatchSetUpdate -> UpdateXssMatchSet
- updateXssMatchSet_xssMatchSetId :: Lens' UpdateXssMatchSet Text
- updateXssMatchSet_changeToken :: Lens' UpdateXssMatchSet Text
- updateXssMatchSet_updates :: Lens' UpdateXssMatchSet (NonEmpty XssMatchSetUpdate)
- data UpdateXssMatchSetResponse = UpdateXssMatchSetResponse' {
- changeToken :: Maybe Text
- httpStatus :: Int
- newUpdateXssMatchSetResponse :: Int -> UpdateXssMatchSetResponse
- updateXssMatchSetResponse_changeToken :: Lens' UpdateXssMatchSetResponse (Maybe Text)
- updateXssMatchSetResponse_httpStatus :: Lens' UpdateXssMatchSetResponse Int
Creating a Request
data UpdateXssMatchSet Source #
A request to update an XssMatchSet.
See: newUpdateXssMatchSet smart constructor.
Constructors
| UpdateXssMatchSet' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty XssMatchSetUpdate | |
| -> UpdateXssMatchSet |
Create a value of UpdateXssMatchSet 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:xssMatchSetId:UpdateXssMatchSet', updateXssMatchSet_xssMatchSetId - The XssMatchSetId of the XssMatchSet that you want to update.
XssMatchSetId is returned by CreateXssMatchSet and by
ListXssMatchSets.
$sel:changeToken:UpdateXssMatchSet', updateXssMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.
$sel:updates:UpdateXssMatchSet', updateXssMatchSet_updates - An array of XssMatchSetUpdate objects that you want to insert into or
delete from an XssMatchSet. For more information, see the applicable
data types:
- XssMatchSetUpdate: Contains
ActionandXssMatchTuple - XssMatchTuple: Contains
FieldToMatchandTextTransformation - FieldToMatch: Contains
DataandType
Request Lenses
updateXssMatchSet_xssMatchSetId :: Lens' UpdateXssMatchSet Text Source #
The XssMatchSetId of the XssMatchSet that you want to update.
XssMatchSetId is returned by CreateXssMatchSet and by
ListXssMatchSets.
updateXssMatchSet_changeToken :: Lens' UpdateXssMatchSet Text Source #
The value returned by the most recent call to GetChangeToken.
updateXssMatchSet_updates :: Lens' UpdateXssMatchSet (NonEmpty XssMatchSetUpdate) Source #
An array of XssMatchSetUpdate objects that you want to insert into or
delete from an XssMatchSet. For more information, see the applicable
data types:
- XssMatchSetUpdate: Contains
ActionandXssMatchTuple - XssMatchTuple: Contains
FieldToMatchandTextTransformation - FieldToMatch: Contains
DataandType
Destructuring the Response
data UpdateXssMatchSetResponse Source #
The response to an UpdateXssMatchSets request.
See: newUpdateXssMatchSetResponse smart constructor.
Constructors
| UpdateXssMatchSetResponse' | |
Fields
| |
Instances
newUpdateXssMatchSetResponse Source #
Create a value of UpdateXssMatchSetResponse 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:UpdateXssMatchSet', updateXssMatchSetResponse_changeToken - The ChangeToken that you used to submit the UpdateXssMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
$sel:httpStatus:UpdateXssMatchSetResponse', updateXssMatchSetResponse_httpStatus - The response's http status code.
Response Lenses
updateXssMatchSetResponse_changeToken :: Lens' UpdateXssMatchSetResponse (Maybe Text) Source #
The ChangeToken that you used to submit the UpdateXssMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
updateXssMatchSetResponse_httpStatus :: Lens' UpdateXssMatchSetResponse Int Source #
The response's http status code.