| 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.CreateByteMatchSet
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.
Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify
the part of a web request that you want AWS WAF to inspect, such as the
values of the User-Agent header or the query string. For example, you
can create a ByteMatchSet that matches any requests with User-Agent
headers that contain the string BadBot. You can then configure AWS WAF
to reject those requests.
To create and configure a ByteMatchSet, perform the following steps:
- Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of aCreateByteMatchSetrequest. - Submit a
CreateByteMatchSetrequest. - Use
GetChangeTokento get the change token that you provide in theChangeTokenparameter of anUpdateByteMatchSetrequest. - Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that 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 CreateByteMatchSet = CreateByteMatchSet' {
- name :: Text
- changeToken :: Text
- newCreateByteMatchSet :: Text -> Text -> CreateByteMatchSet
- createByteMatchSet_name :: Lens' CreateByteMatchSet Text
- createByteMatchSet_changeToken :: Lens' CreateByteMatchSet Text
- data CreateByteMatchSetResponse = CreateByteMatchSetResponse' {}
- newCreateByteMatchSetResponse :: Int -> CreateByteMatchSetResponse
- createByteMatchSetResponse_byteMatchSet :: Lens' CreateByteMatchSetResponse (Maybe ByteMatchSet)
- createByteMatchSetResponse_changeToken :: Lens' CreateByteMatchSetResponse (Maybe Text)
- createByteMatchSetResponse_httpStatus :: Lens' CreateByteMatchSetResponse Int
Creating a Request
data CreateByteMatchSet Source #
See: newCreateByteMatchSet smart constructor.
Constructors
| CreateByteMatchSet' | |
Fields
| |
Instances
newCreateByteMatchSet Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateByteMatchSet |
Create a value of CreateByteMatchSet 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:name:CreateByteMatchSet', createByteMatchSet_name - A friendly name or description of the ByteMatchSet. You can't change
Name after you create a ByteMatchSet.
$sel:changeToken:CreateByteMatchSet', createByteMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.
Request Lenses
createByteMatchSet_name :: Lens' CreateByteMatchSet Text Source #
A friendly name or description of the ByteMatchSet. You can't change
Name after you create a ByteMatchSet.
createByteMatchSet_changeToken :: Lens' CreateByteMatchSet Text Source #
The value returned by the most recent call to GetChangeToken.
Destructuring the Response
data CreateByteMatchSetResponse Source #
See: newCreateByteMatchSetResponse smart constructor.
Constructors
| CreateByteMatchSetResponse' | |
Fields
| |
Instances
newCreateByteMatchSetResponse Source #
Create a value of CreateByteMatchSetResponse 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:byteMatchSet:CreateByteMatchSetResponse', createByteMatchSetResponse_byteMatchSet - A ByteMatchSet that contains no ByteMatchTuple objects.
$sel:changeToken:CreateByteMatchSet', createByteMatchSetResponse_changeToken - The ChangeToken that you used to submit the CreateByteMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
$sel:httpStatus:CreateByteMatchSetResponse', createByteMatchSetResponse_httpStatus - The response's http status code.
Response Lenses
createByteMatchSetResponse_byteMatchSet :: Lens' CreateByteMatchSetResponse (Maybe ByteMatchSet) Source #
A ByteMatchSet that contains no ByteMatchTuple objects.
createByteMatchSetResponse_changeToken :: Lens' CreateByteMatchSetResponse (Maybe Text) Source #
The ChangeToken that you used to submit the CreateByteMatchSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
createByteMatchSetResponse_httpStatus :: Lens' CreateByteMatchSetResponse Int Source #
The response's http status code.