libZSservicesZSamazonka-wafZSamazonka-waf
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.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 RegexMatchSetUpdate object, 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-Agent header.
  • 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:

  1. Create a RegexMatchSet. For more information, see CreateRegexMatchSet.
  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.
  3. Submit an UpdateRegexMatchSet request 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 the RegexPatternSet that 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

Creating a Request

data UpdateRegexMatchSet Source #

See: newUpdateRegexMatchSet smart constructor.

Constructors

UpdateRegexMatchSet' 

Fields

  • regexMatchSetId :: Text

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

  • updates :: NonEmpty RegexMatchSetUpdate

    An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
Eq UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Read UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Show UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Generic UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Associated Types

type Rep UpdateRegexMatchSet :: Type -> Type #

NFData UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Methods

rnf :: UpdateRegexMatchSet -> () #

Hashable UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

ToJSON UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

AWSRequest UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Associated Types

type AWSResponse UpdateRegexMatchSet #

ToHeaders UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

ToPath UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

ToQuery UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

type Rep UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

type Rep UpdateRegexMatchSet = D1 ('MetaData "UpdateRegexMatchSet" "Amazonka.WAF.UpdateRegexMatchSet" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "UpdateRegexMatchSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "regexMatchSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty RegexMatchSetUpdate)) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateRegexMatchSet Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

newUpdateRegexMatchSet Source #

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

  • changeToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq UpdateRegexMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Read UpdateRegexMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Show UpdateRegexMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Generic UpdateRegexMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

Associated Types

type Rep UpdateRegexMatchSetResponse :: Type -> Type #

NFData UpdateRegexMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

type Rep UpdateRegexMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.UpdateRegexMatchSet

type Rep UpdateRegexMatchSetResponse = D1 ('MetaData "UpdateRegexMatchSetResponse" "Amazonka.WAF.UpdateRegexMatchSet" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "UpdateRegexMatchSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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.