{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.WAFRegional.CreateRegexMatchSet -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- This is __AWS WAF Classic__ documentation. For more information, see -- -- in the developer guide. -- -- __For the latest version of AWS WAF__, use the AWS WAFV2 API and see the -- . -- 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: -- -- 1. Use GetChangeToken to get the change token that you provide in the -- @ChangeToken@ parameter of a @CreateRegexMatchSet@ request. -- -- 2. Submit a @CreateRegexMatchSet@ request. -- -- 3. Use @GetChangeToken@ to get the change token that you provide in the -- @ChangeToken@ parameter of an @UpdateRegexMatchSet@ request. -- -- 4. 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 -- . module Amazonka.WAFRegional.CreateRegexMatchSet ( -- * Creating a Request CreateRegexMatchSet (..), newCreateRegexMatchSet, -- * Request Lenses createRegexMatchSet_name, createRegexMatchSet_changeToken, -- * Destructuring the Response CreateRegexMatchSetResponse (..), newCreateRegexMatchSetResponse, -- * Response Lenses createRegexMatchSetResponse_changeToken, createRegexMatchSetResponse_regexMatchSet, createRegexMatchSetResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.WAFRegional.Types -- | /See:/ 'newCreateRegexMatchSet' smart constructor. data CreateRegexMatchSet = CreateRegexMatchSet' { -- | A friendly name or description of the RegexMatchSet. You can\'t change -- @Name@ after you create a @RegexMatchSet@. name :: Prelude.Text, -- | The value returned by the most recent call to GetChangeToken. changeToken :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateRegexMatchSet' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'name', 'createRegexMatchSet_name' - A friendly name or description of the RegexMatchSet. You can\'t change -- @Name@ after you create a @RegexMatchSet@. -- -- 'changeToken', 'createRegexMatchSet_changeToken' - The value returned by the most recent call to GetChangeToken. newCreateRegexMatchSet :: -- | 'name' Prelude.Text -> -- | 'changeToken' Prelude.Text -> CreateRegexMatchSet newCreateRegexMatchSet pName_ pChangeToken_ = CreateRegexMatchSet' { name = pName_, changeToken = pChangeToken_ } -- | A friendly name or description of the RegexMatchSet. You can\'t change -- @Name@ after you create a @RegexMatchSet@. createRegexMatchSet_name :: Lens.Lens' CreateRegexMatchSet Prelude.Text createRegexMatchSet_name = Lens.lens (\CreateRegexMatchSet' {name} -> name) (\s@CreateRegexMatchSet' {} a -> s {name = a} :: CreateRegexMatchSet) -- | The value returned by the most recent call to GetChangeToken. createRegexMatchSet_changeToken :: Lens.Lens' CreateRegexMatchSet Prelude.Text createRegexMatchSet_changeToken = Lens.lens (\CreateRegexMatchSet' {changeToken} -> changeToken) (\s@CreateRegexMatchSet' {} a -> s {changeToken = a} :: CreateRegexMatchSet) instance Core.AWSRequest CreateRegexMatchSet where type AWSResponse CreateRegexMatchSet = CreateRegexMatchSetResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> CreateRegexMatchSetResponse' Prelude.<$> (x Data..?> "ChangeToken") Prelude.<*> (x Data..?> "RegexMatchSet") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable CreateRegexMatchSet where hashWithSalt _salt CreateRegexMatchSet' {..} = _salt `Prelude.hashWithSalt` name `Prelude.hashWithSalt` changeToken instance Prelude.NFData CreateRegexMatchSet where rnf CreateRegexMatchSet' {..} = Prelude.rnf name `Prelude.seq` Prelude.rnf changeToken instance Data.ToHeaders CreateRegexMatchSet where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSWAF_Regional_20161128.CreateRegexMatchSet" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON CreateRegexMatchSet where toJSON CreateRegexMatchSet' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("Name" Data..= name), Prelude.Just ("ChangeToken" Data..= changeToken) ] ) instance Data.ToPath CreateRegexMatchSet where toPath = Prelude.const "/" instance Data.ToQuery CreateRegexMatchSet where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newCreateRegexMatchSetResponse' smart constructor. data CreateRegexMatchSetResponse = CreateRegexMatchSetResponse' { -- | 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. changeToken :: Prelude.Maybe Prelude.Text, -- | A RegexMatchSet that contains no @RegexMatchTuple@ objects. regexMatchSet :: Prelude.Maybe RegexMatchSet, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateRegexMatchSetResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'changeToken', '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. -- -- 'regexMatchSet', 'createRegexMatchSetResponse_regexMatchSet' - A RegexMatchSet that contains no @RegexMatchTuple@ objects. -- -- 'httpStatus', 'createRegexMatchSetResponse_httpStatus' - The response's http status code. newCreateRegexMatchSetResponse :: -- | 'httpStatus' Prelude.Int -> CreateRegexMatchSetResponse newCreateRegexMatchSetResponse pHttpStatus_ = CreateRegexMatchSetResponse' { changeToken = Prelude.Nothing, regexMatchSet = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | 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_changeToken :: Lens.Lens' CreateRegexMatchSetResponse (Prelude.Maybe Prelude.Text) createRegexMatchSetResponse_changeToken = Lens.lens (\CreateRegexMatchSetResponse' {changeToken} -> changeToken) (\s@CreateRegexMatchSetResponse' {} a -> s {changeToken = a} :: CreateRegexMatchSetResponse) -- | A RegexMatchSet that contains no @RegexMatchTuple@ objects. createRegexMatchSetResponse_regexMatchSet :: Lens.Lens' CreateRegexMatchSetResponse (Prelude.Maybe RegexMatchSet) createRegexMatchSetResponse_regexMatchSet = Lens.lens (\CreateRegexMatchSetResponse' {regexMatchSet} -> regexMatchSet) (\s@CreateRegexMatchSetResponse' {} a -> s {regexMatchSet = a} :: CreateRegexMatchSetResponse) -- | The response's http status code. createRegexMatchSetResponse_httpStatus :: Lens.Lens' CreateRegexMatchSetResponse Prelude.Int createRegexMatchSetResponse_httpStatus = Lens.lens (\CreateRegexMatchSetResponse' {httpStatus} -> httpStatus) (\s@CreateRegexMatchSetResponse' {} a -> s {httpStatus = a} :: CreateRegexMatchSetResponse) instance Prelude.NFData CreateRegexMatchSetResponse where rnf CreateRegexMatchSetResponse' {..} = Prelude.rnf changeToken `Prelude.seq` Prelude.rnf regexMatchSet `Prelude.seq` Prelude.rnf httpStatus