| 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.CreateSizeConstraintSet
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 SizeConstraintSet. You then use UpdateSizeConstraintSet to
identify the part of a web request that you want AWS WAF to check for
length, such as the length of the User-Agent header or the length of
the query string. For example, you can create a SizeConstraintSet that
matches any requests that have a query string that is longer than 100
bytes. You can then configure AWS WAF to reject those requests.
To create and configure a SizeConstraintSet, perform the following
steps:
- Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of aCreateSizeConstraintSetrequest. - Submit a
CreateSizeConstraintSetrequest. - Use
GetChangeTokento get the change token that you provide in theChangeTokenparameter of anUpdateSizeConstraintSetrequest. - Submit an UpdateSizeConstraintSet 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 CreateSizeConstraintSet = CreateSizeConstraintSet' {
- name :: Text
- changeToken :: Text
- newCreateSizeConstraintSet :: Text -> Text -> CreateSizeConstraintSet
- createSizeConstraintSet_name :: Lens' CreateSizeConstraintSet Text
- createSizeConstraintSet_changeToken :: Lens' CreateSizeConstraintSet Text
- data CreateSizeConstraintSetResponse = CreateSizeConstraintSetResponse' {}
- newCreateSizeConstraintSetResponse :: Int -> CreateSizeConstraintSetResponse
- createSizeConstraintSetResponse_sizeConstraintSet :: Lens' CreateSizeConstraintSetResponse (Maybe SizeConstraintSet)
- createSizeConstraintSetResponse_changeToken :: Lens' CreateSizeConstraintSetResponse (Maybe Text)
- createSizeConstraintSetResponse_httpStatus :: Lens' CreateSizeConstraintSetResponse Int
Creating a Request
data CreateSizeConstraintSet Source #
See: newCreateSizeConstraintSet smart constructor.
Constructors
| CreateSizeConstraintSet' | |
Fields
| |
Instances
newCreateSizeConstraintSet Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateSizeConstraintSet |
Create a value of CreateSizeConstraintSet 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:CreateSizeConstraintSet', createSizeConstraintSet_name - A friendly name or description of the SizeConstraintSet. You can't
change Name after you create a SizeConstraintSet.
$sel:changeToken:CreateSizeConstraintSet', createSizeConstraintSet_changeToken - The value returned by the most recent call to GetChangeToken.
Request Lenses
createSizeConstraintSet_name :: Lens' CreateSizeConstraintSet Text Source #
A friendly name or description of the SizeConstraintSet. You can't
change Name after you create a SizeConstraintSet.
createSizeConstraintSet_changeToken :: Lens' CreateSizeConstraintSet Text Source #
The value returned by the most recent call to GetChangeToken.
Destructuring the Response
data CreateSizeConstraintSetResponse Source #
See: newCreateSizeConstraintSetResponse smart constructor.
Constructors
| CreateSizeConstraintSetResponse' | |
Fields
| |
Instances
newCreateSizeConstraintSetResponse Source #
Create a value of CreateSizeConstraintSetResponse 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:sizeConstraintSet:CreateSizeConstraintSetResponse', createSizeConstraintSetResponse_sizeConstraintSet - A SizeConstraintSet that contains no SizeConstraint objects.
$sel:changeToken:CreateSizeConstraintSet', createSizeConstraintSetResponse_changeToken - The ChangeToken that you used to submit the CreateSizeConstraintSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
$sel:httpStatus:CreateSizeConstraintSetResponse', createSizeConstraintSetResponse_httpStatus - The response's http status code.
Response Lenses
createSizeConstraintSetResponse_sizeConstraintSet :: Lens' CreateSizeConstraintSetResponse (Maybe SizeConstraintSet) Source #
A SizeConstraintSet that contains no SizeConstraint objects.
createSizeConstraintSetResponse_changeToken :: Lens' CreateSizeConstraintSetResponse (Maybe Text) Source #
The ChangeToken that you used to submit the CreateSizeConstraintSet
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
createSizeConstraintSetResponse_httpStatus :: Lens' CreateSizeConstraintSetResponse Int Source #
The response's http status code.