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

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 an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

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

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

See: newCreateGeoMatchSet smart constructor.

Constructors

CreateGeoMatchSet' 

Fields

  • name :: Text

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

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
ToJSON CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

ToHeaders CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

ToPath CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

ToQuery CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

AWSRequest CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Associated Types

type AWSResponse CreateGeoMatchSet #

Generic CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Associated Types

type Rep CreateGeoMatchSet :: Type -> Type #

Read CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Show CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

NFData CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Methods

rnf :: CreateGeoMatchSet -> () #

Eq CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Hashable CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

type AWSResponse CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

type Rep CreateGeoMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

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

newCreateGeoMatchSet Source #

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

CreateGeoMatchSet, createGeoMatchSet_name - A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet.

CreateGeoMatchSet, createGeoMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

createGeoMatchSet_name :: Lens' CreateGeoMatchSet Text Source #

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

createGeoMatchSet_changeToken :: Lens' CreateGeoMatchSet Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data CreateGeoMatchSetResponse Source #

See: newCreateGeoMatchSetResponse smart constructor.

Constructors

CreateGeoMatchSetResponse' 

Fields

  • changeToken :: Maybe Text

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

  • geoMatchSet :: Maybe GeoMatchSet

    The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateGeoMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Associated Types

type Rep CreateGeoMatchSetResponse :: Type -> Type #

Read CreateGeoMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Show CreateGeoMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

NFData CreateGeoMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

Eq CreateGeoMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

type Rep CreateGeoMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateGeoMatchSet

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

newCreateGeoMatchSetResponse Source #

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

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

$sel:geoMatchSet:CreateGeoMatchSetResponse', createGeoMatchSetResponse_geoMatchSet - The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.

$sel:httpStatus:CreateGeoMatchSetResponse', createGeoMatchSetResponse_httpStatus - The response's http status code.

Response Lenses

createGeoMatchSetResponse_changeToken :: Lens' CreateGeoMatchSetResponse (Maybe Text) Source #

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

createGeoMatchSetResponse_geoMatchSet :: Lens' CreateGeoMatchSetResponse (Maybe GeoMatchSet) Source #

The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.