libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAFRegional.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:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.
  2. Submit a CreateSizeConstraintSet request.
  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.
  4. 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

Creating a Request

data CreateSizeConstraintSet Source #

See: newCreateSizeConstraintSet smart constructor.

Constructors

CreateSizeConstraintSet' 

Fields

  • name :: Text

    A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
Eq CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Read CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Show CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Generic CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Associated Types

type Rep CreateSizeConstraintSet :: Type -> Type #

NFData CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Methods

rnf :: CreateSizeConstraintSet -> () #

Hashable CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

ToJSON CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

AWSRequest CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

ToHeaders CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

ToPath CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

ToQuery CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

type Rep CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

type Rep CreateSizeConstraintSet = D1 ('MetaData "CreateSizeConstraintSet" "Amazonka.WAFRegional.CreateSizeConstraintSet" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "CreateSizeConstraintSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateSizeConstraintSet Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

newCreateSizeConstraintSet Source #

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

  • sizeConstraintSet :: Maybe SizeConstraintSet

    A SizeConstraintSet that contains no SizeConstraint objects.

  • changeToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateSizeConstraintSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Read CreateSizeConstraintSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Show CreateSizeConstraintSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Generic CreateSizeConstraintSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

Associated Types

type Rep CreateSizeConstraintSetResponse :: Type -> Type #

NFData CreateSizeConstraintSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

type Rep CreateSizeConstraintSetResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.CreateSizeConstraintSet

type Rep CreateSizeConstraintSetResponse = D1 ('MetaData "CreateSizeConstraintSetResponse" "Amazonka.WAFRegional.CreateSizeConstraintSet" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "CreateSizeConstraintSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sizeConstraintSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SizeConstraintSet)) :*: (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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_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.