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.WAFV2.CreateIPSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

Synopsis

data CreateIPSet = CreateIPSet' {
- description :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- name :: Text
- scope :: Scope
- iPAddressVersion :: IPAddressVersion
- addresses :: [Text]
}
newCreateIPSet :: Text -> Scope -> IPAddressVersion -> CreateIPSet
createIPSet_description :: Lens' CreateIPSet (Maybe Text)
createIPSet_tags :: Lens' CreateIPSet (Maybe (NonEmpty Tag))
createIPSet_name :: Lens' CreateIPSet Text
createIPSet_scope :: Lens' CreateIPSet Scope
createIPSet_iPAddressVersion :: Lens' CreateIPSet IPAddressVersion
createIPSet_addresses :: Lens' CreateIPSet [Text]
data CreateIPSetResponse = CreateIPSetResponse' {
- summary :: Maybe IPSetSummary
- httpStatus :: Int
}
newCreateIPSetResponse :: Int -> CreateIPSetResponse
createIPSetResponse_summary :: Lens' CreateIPSetResponse (Maybe IPSetSummary)
createIPSetResponse_httpStatus :: Lens' CreateIPSetResponse Int

Creating a Request

data CreateIPSet Source #

See: newCreateIPSet smart constructor.

Constructors

CreateIPSet'

Fields

description :: Maybe Text
A description of the IP set that helps with identification.
tags :: Maybe (NonEmpty Tag)
An array of key:value pairs to associate with the resource.
name :: Text
The name of the IP set. You cannot change the name of an IPSet after you create it.
scope :: Scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
- API and SDKs - For all calls, use the Region endpoint us-east-1.
iPAddressVersion :: IPAddressVersion
The version of the IP addresses, either IPV4 or IPV6.
addresses :: [Text]
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
- To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
- To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
- To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
- To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses specifications:
- Empty array: "Addresses": []
- Array with one address: "Addresses": ["192.0.2.44/32"]
- Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
- INVALID specification: "Addresses": [""] INVALID

Instances

Instances details

ToJSON CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods toJSON :: CreateIPSet -> Value # toEncoding :: CreateIPSet -> Encoding # toJSONList :: [CreateIPSet] -> Value # toEncodingList :: [CreateIPSet] -> Encoding #
ToHeaders CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods toHeaders :: CreateIPSet -> [Header] #
ToPath CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods toPath :: CreateIPSet -> ByteString #
ToQuery CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods toQuery :: CreateIPSet -> QueryString #
AWSRequest CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.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.WAFV2.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.WAFV2.CreateIPSet Methods readsPrec :: Int -> ReadS CreateIPSet # readList :: ReadS [CreateIPSet] # readPrec :: ReadPrec CreateIPSet # readListPrec :: ReadPrec [CreateIPSet] #
Show CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods showsPrec :: Int -> CreateIPSet -> ShowS # show :: CreateIPSet -> String # showList :: [CreateIPSet] -> ShowS #
NFData CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods rnf :: CreateIPSet -> () #
Eq CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods (==) :: CreateIPSet -> CreateIPSet -> Bool # (/=) :: CreateIPSet -> CreateIPSet -> Bool #
Hashable CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods hashWithSalt :: Int -> CreateIPSet -> Int # hash :: CreateIPSet -> Int #
type AWSResponse CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet type AWSResponse CreateIPSet = CreateIPSetResponse
type Rep CreateIPSet Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet type Rep CreateIPSet = D1 ('MetaData "CreateIPSet" "Amazonka.WAFV2.CreateIPSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "CreateIPSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope) :: (S1 ('MetaSel ('Just "iPAddressVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPAddressVersion) :*: S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newCreateIPSet Source #

Arguments

:: Text	`CreateIPSet`
-> Scope	`CreateIPSet`
-> IPAddressVersion	`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_description - A description of the IP set that helps with identification.

CreateIPSet, createIPSet_tags - An array of key:value pairs to associate with the resource.

CreateIPSet, createIPSet_name - The name of the IP set. You cannot change the name of an IPSet after you create it.

CreateIPSet, createIPSet_scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.

CreateIPSet, createIPSet_iPAddressVersion - The version of the IP addresses, either IPV4 or IPV6.

CreateIPSet, createIPSet_addresses - Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""] INVALID

Request Lenses

createIPSet_description :: Lens' CreateIPSet (Maybe Text) Source #

A description of the IP set that helps with identification.

createIPSet_tags :: Lens' CreateIPSet (Maybe (NonEmpty Tag)) Source #

An array of key:value pairs to associate with the resource.

createIPSet_name :: Lens' CreateIPSet Text Source #

The name of the IP set. You cannot change the name of an IPSet after you create it.

createIPSet_scope :: Lens' CreateIPSet Scope Source #

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.

createIPSet_iPAddressVersion :: Lens' CreateIPSet IPAddressVersion Source #

The version of the IP addresses, either IPV4 or IPV6.

createIPSet_addresses :: Lens' CreateIPSet [Text] Source #

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Example JSON Addresses specifications:

Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""] INVALID

Destructuring the Response

data CreateIPSetResponse Source #

See: newCreateIPSetResponse smart constructor.

Constructors

CreateIPSetResponse'
Fields summary :: Maybe IPSetSummary High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an `IPSet`, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.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.WAFV2.CreateIPSet Methods readsPrec :: Int -> ReadS CreateIPSetResponse # readList :: ReadS [CreateIPSetResponse] # readPrec :: ReadPrec CreateIPSetResponse # readListPrec :: ReadPrec [CreateIPSetResponse] #
Show CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods showsPrec :: Int -> CreateIPSetResponse -> ShowS # show :: CreateIPSetResponse -> String # showList :: [CreateIPSetResponse] -> ShowS #
NFData CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods rnf :: CreateIPSetResponse -> () #
Eq CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet Methods (==) :: CreateIPSetResponse -> CreateIPSetResponse -> Bool # (/=) :: CreateIPSetResponse -> CreateIPSetResponse -> Bool #
type Rep CreateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.CreateIPSet type Rep CreateIPSetResponse = D1 ('MetaData "CreateIPSetResponse" "Amazonka.WAFV2.CreateIPSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "CreateIPSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IPSetSummary)) :*: 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:

$sel:summary:CreateIPSetResponse', createIPSetResponse_summary - High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

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

Response Lenses

createIPSetResponse_summary :: Lens' CreateIPSetResponse (Maybe IPSetSummary) Source #

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

createIPSetResponse_httpStatus :: Lens' CreateIPSetResponse Int Source #

The response's http status code.