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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 RegexMatchSet. You then use UpdateRegexMatchSet 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 RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern 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:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request.
Submit a CreateRegexMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.
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 value, using a RegexPatternSet, 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.

Creating a Request

data CreateRegexMatchSet Source #

See: newCreateRegexMatchSet smart constructor.

Constructors

CreateRegexMatchSet'
Fields name :: Text A friendly name or description of the RegexMatchSet. You can't change `Name` after you create a `RegexMatchSet`. changeToken :: Text The value returned by the most recent call to GetChangeToken.

Instances

Instances details

Eq CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods (==) :: CreateRegexMatchSet -> CreateRegexMatchSet -> Bool # (/=) :: CreateRegexMatchSet -> CreateRegexMatchSet -> Bool #
Read CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods readsPrec :: Int -> ReadS CreateRegexMatchSet # readList :: ReadS [CreateRegexMatchSet] # readPrec :: ReadPrec CreateRegexMatchSet # readListPrec :: ReadPrec [CreateRegexMatchSet] #
Show CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods showsPrec :: Int -> CreateRegexMatchSet -> ShowS # show :: CreateRegexMatchSet -> String # showList :: [CreateRegexMatchSet] -> ShowS #
Generic CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Associated Types type Rep CreateRegexMatchSet :: Type -> Type # Methods from :: CreateRegexMatchSet -> Rep CreateRegexMatchSet x # to :: Rep CreateRegexMatchSet x -> CreateRegexMatchSet #
NFData CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods rnf :: CreateRegexMatchSet -> () #
Hashable CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods hashWithSalt :: Int -> CreateRegexMatchSet -> Int # hash :: CreateRegexMatchSet -> Int #
ToJSON CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods toJSON :: CreateRegexMatchSet -> Value # toEncoding :: CreateRegexMatchSet -> Encoding # toJSONList :: [CreateRegexMatchSet] -> Value # toEncodingList :: [CreateRegexMatchSet] -> Encoding #
AWSRequest CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Associated Types type AWSResponse CreateRegexMatchSet # Methods request :: CreateRegexMatchSet -> Request CreateRegexMatchSet # response :: MonadResource m => Logger -> Service -> Proxy CreateRegexMatchSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRegexMatchSet))) #
ToHeaders CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods toHeaders :: CreateRegexMatchSet -> [Header] #
ToPath CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods toPath :: CreateRegexMatchSet -> ByteString #
ToQuery CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods toQuery :: CreateRegexMatchSet -> QueryString #
type Rep CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet type Rep CreateRegexMatchSet = D1 ('MetaData "CreateRegexMatchSet" "Amazonka.WAF.CreateRegexMatchSet" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "CreateRegexMatchSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateRegexMatchSet Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet type AWSResponse CreateRegexMatchSet = CreateRegexMatchSetResponse

newCreateRegexMatchSet Source #

Arguments

:: Text	`$sel:name:CreateRegexMatchSet'`
-> Text	`$sel:changeToken:CreateRegexMatchSet'`
-> CreateRegexMatchSet

Create a value of CreateRegexMatchSet 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:CreateRegexMatchSet', createRegexMatchSet_name - A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

$sel:changeToken:CreateRegexMatchSet', createRegexMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

createRegexMatchSet_name :: Lens' CreateRegexMatchSet Text Source #

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

createRegexMatchSet_changeToken :: Lens' CreateRegexMatchSet Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data CreateRegexMatchSetResponse Source #

See: newCreateRegexMatchSetResponse smart constructor.

Constructors

CreateRegexMatchSetResponse'
Fields regexMatchSet :: Maybe RegexMatchSet A RegexMatchSet that contains no `RegexMatchTuple` objects. changeToken :: Maybe Text The `ChangeToken` that you used to submit the `CreateRegexMatchSet` 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 CreateRegexMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods (==) :: CreateRegexMatchSetResponse -> CreateRegexMatchSetResponse -> Bool # (/=) :: CreateRegexMatchSetResponse -> CreateRegexMatchSetResponse -> Bool #
Read CreateRegexMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods readsPrec :: Int -> ReadS CreateRegexMatchSetResponse # readList :: ReadS [CreateRegexMatchSetResponse] # readPrec :: ReadPrec CreateRegexMatchSetResponse # readListPrec :: ReadPrec [CreateRegexMatchSetResponse] #
Show CreateRegexMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods showsPrec :: Int -> CreateRegexMatchSetResponse -> ShowS # show :: CreateRegexMatchSetResponse -> String # showList :: [CreateRegexMatchSetResponse] -> ShowS #
Generic CreateRegexMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Associated Types type Rep CreateRegexMatchSetResponse :: Type -> Type # Methods from :: CreateRegexMatchSetResponse -> Rep CreateRegexMatchSetResponse x # to :: Rep CreateRegexMatchSetResponse x -> CreateRegexMatchSetResponse #
NFData CreateRegexMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet Methods rnf :: CreateRegexMatchSetResponse -> () #
type Rep CreateRegexMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateRegexMatchSet type Rep CreateRegexMatchSetResponse = D1 ('MetaData "CreateRegexMatchSetResponse" "Amazonka.WAF.CreateRegexMatchSet" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "CreateRegexMatchSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "regexMatchSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegexMatchSet)) :: (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateRegexMatchSetResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateRegexMatchSetResponse'`
-> CreateRegexMatchSetResponse

Create a value of CreateRegexMatchSetResponse 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:regexMatchSet:CreateRegexMatchSetResponse', createRegexMatchSetResponse_regexMatchSet - A RegexMatchSet that contains no RegexMatchTuple objects.

$sel:changeToken:CreateRegexMatchSet', createRegexMatchSetResponse_changeToken - The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

$sel:httpStatus:CreateRegexMatchSetResponse', createRegexMatchSetResponse_httpStatus - The response's http status code.

Response Lenses

createRegexMatchSetResponse_regexMatchSet :: Lens' CreateRegexMatchSetResponse (Maybe RegexMatchSet) Source #

A RegexMatchSet that contains no RegexMatchTuple objects.

createRegexMatchSetResponse_changeToken :: Lens' CreateRegexMatchSetResponse (Maybe Text) Source #

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

createRegexMatchSetResponse_httpStatus :: Lens' CreateRegexMatchSetResponse Int Source #

The response's http status code.