amazonka-waf-2.0: Amazon WAF SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAF.CreateRegexPatternSet

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 RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexPatternSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request.
  2. Submit a CreateRegexPatternSet request.
  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.
  4. Submit an UpdateRegexPatternSet request to specify the string 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 CreateRegexPatternSet Source #

See: newCreateRegexPatternSet smart constructor.

Constructors

CreateRegexPatternSet' 

Fields

  • name :: Text

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

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
ToJSON CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

ToHeaders CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

ToPath CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

ToQuery CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

AWSRequest CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Associated Types

type AWSResponse CreateRegexPatternSet #

Generic CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Associated Types

type Rep CreateRegexPatternSet :: Type -> Type #

Read CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Show CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

NFData CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Methods

rnf :: CreateRegexPatternSet -> () #

Eq CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Hashable CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

type AWSResponse CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

type Rep CreateRegexPatternSet Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

type Rep CreateRegexPatternSet = D1 ('MetaData "CreateRegexPatternSet" "Amazonka.WAF.CreateRegexPatternSet" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "CreateRegexPatternSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateRegexPatternSet Source #

Create a value of CreateRegexPatternSet 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:

CreateRegexPatternSet, createRegexPatternSet_name - A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

CreateRegexPatternSet, createRegexPatternSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

createRegexPatternSet_name :: Lens' CreateRegexPatternSet Text Source #

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

createRegexPatternSet_changeToken :: Lens' CreateRegexPatternSet Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data CreateRegexPatternSetResponse Source #

See: newCreateRegexPatternSetResponse smart constructor.

Constructors

CreateRegexPatternSetResponse' 

Fields

  • changeToken :: Maybe Text

    The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

  • regexPatternSet :: Maybe RegexPatternSet

    A RegexPatternSet that contains no objects.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateRegexPatternSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Associated Types

type Rep CreateRegexPatternSetResponse :: Type -> Type #

Read CreateRegexPatternSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Show CreateRegexPatternSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

NFData CreateRegexPatternSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

Eq CreateRegexPatternSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

type Rep CreateRegexPatternSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateRegexPatternSet

type Rep CreateRegexPatternSetResponse = D1 ('MetaData "CreateRegexPatternSetResponse" "Amazonka.WAF.CreateRegexPatternSet" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "CreateRegexPatternSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "regexPatternSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegexPatternSet)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateRegexPatternSetResponse Source #

Create a value of CreateRegexPatternSetResponse 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:

CreateRegexPatternSet, createRegexPatternSetResponse_changeToken - The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

$sel:regexPatternSet:CreateRegexPatternSetResponse', createRegexPatternSetResponse_regexPatternSet - A RegexPatternSet that contains no objects.

$sel:httpStatus:CreateRegexPatternSetResponse', createRegexPatternSetResponse_httpStatus - The response's http status code.

Response Lenses

createRegexPatternSetResponse_changeToken :: Lens' CreateRegexPatternSetResponse (Maybe Text) Source #

The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.