Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WAFRegional.CreateIPSet

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

To create and configure an IPSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateIPSet request to specify the IP addresses 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 CreateIPSet Source #

See: newCreateIPSet smart constructor.

Constructors

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

Instances

Instances details

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

newCreateIPSet Source #

Arguments

:: Text	`CreateIPSet`
-> Text	`CreateIPSet`
-> CreateIPSet

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

CreateIPSet, createIPSet_name - A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

CreateIPSet, createIPSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

createIPSet_name :: Lens' CreateIPSet Text Source #

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

createIPSet_changeToken :: Lens' CreateIPSet Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data CreateIPSetResponse Source #

See: newCreateIPSetResponse smart constructor.

Constructors

CreateIPSetResponse'
Fields changeToken :: Maybe Text The `ChangeToken` that you used to submit the `CreateIPSet` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. iPSet :: Maybe IPSet The IPSet returned in the `CreateIPSet` response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateIPSet Associated Types type Rep CreateIPSetResponse :: Type -> Type # Methods from :: CreateIPSetResponse -> Rep CreateIPSetResponse x # to :: Rep CreateIPSetResponse x -> CreateIPSetResponse #
Read CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateIPSet Methods readsPrec :: Int -> ReadS CreateIPSetResponse # readList :: ReadS [CreateIPSetResponse] # readPrec :: ReadPrec CreateIPSetResponse # readListPrec :: ReadPrec [CreateIPSetResponse] #
Show CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateIPSet Methods showsPrec :: Int -> CreateIPSetResponse -> ShowS # show :: CreateIPSetResponse -> String # showList :: [CreateIPSetResponse] -> ShowS #
NFData CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateIPSet Methods rnf :: CreateIPSetResponse -> () #
Eq CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateIPSet Methods (==) :: CreateIPSetResponse -> CreateIPSetResponse -> Bool # (/=) :: CreateIPSetResponse -> CreateIPSetResponse -> Bool #
type Rep CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateIPSet type Rep CreateIPSetResponse = D1 ('MetaData "CreateIPSetResponse" "Amazonka.WAFRegional.CreateIPSet" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "CreateIPSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "iPSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IPSet)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateIPSetResponse Source #

Arguments

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

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

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

$sel:iPSet:CreateIPSetResponse', createIPSetResponse_iPSet - The IPSet returned in the CreateIPSet response.

$sel:httpStatus:CreateIPSetResponse', createIPSetResponse_httpStatus - The response's http status code.

Response Lenses

createIPSetResponse_changeToken :: Lens' CreateIPSetResponse (Maybe Text) Source #

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

createIPSetResponse_iPSet :: Lens' CreateIPSetResponse (Maybe IPSet) Source #

The IPSet returned in the CreateIPSet response.

createIPSetResponse_httpStatus :: Lens' CreateIPSetResponse Int Source #

The response's http status code.