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.Types.IPSet

Description

Synopsis

data IPSet = IPSet' {
- description :: Maybe Text
- name :: Text
- id :: Text
- arn :: Text
- iPAddressVersion :: IPAddressVersion
- addresses :: [Text]
}
newIPSet :: Text -> Text -> Text -> IPAddressVersion -> IPSet
iPSet_description :: Lens' IPSet (Maybe Text)
iPSet_name :: Lens' IPSet Text
iPSet_id :: Lens' IPSet Text
iPSet_arn :: Lens' IPSet Text
iPSet_iPAddressVersion :: Lens' IPSet IPAddressVersion
iPSet_addresses :: Lens' IPSet [Text]

Documentation

data IPSet Source #

Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

See: newIPSet smart constructor.

Constructors

IPSet'

Fields

description :: Maybe Text
A description of the IP set that helps with identification.
name :: Text
The name of the IP set. You cannot change the name of an IPSet after you create it.
id :: Text
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
arn :: Text
The Amazon Resource Name (ARN) of the entity.
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

FromJSON IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet Methods parseJSON :: Value -> Parser IPSet # parseJSONList :: Value -> Parser [IPSet] #
Generic IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet Associated Types type Rep IPSet :: Type -> Type # Methods from :: IPSet -> Rep IPSet x # to :: Rep IPSet x -> IPSet #
Read IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet Methods readsPrec :: Int -> ReadS IPSet # readList :: ReadS [IPSet] # readPrec :: ReadPrec IPSet # readListPrec :: ReadPrec [IPSet] #
Show IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet Methods showsPrec :: Int -> IPSet -> ShowS # show :: IPSet -> String # showList :: [IPSet] -> ShowS #
NFData IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet Methods rnf :: IPSet -> () #
Eq IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet Methods (==) :: IPSet -> IPSet -> Bool # (/=) :: IPSet -> IPSet -> Bool #
Hashable IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet Methods hashWithSalt :: Int -> IPSet -> Int # hash :: IPSet -> Int #
type Rep IPSet Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSet type Rep IPSet = D1 ('MetaData "IPSet" "Amazonka.WAFV2.Types.IPSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "IPSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "iPAddressVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPAddressVersion) :*: S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newIPSet Source #

Arguments

:: Text	`$sel:name:IPSet'`
-> Text	`$sel:id:IPSet'`
-> Text	`$sel:arn:IPSet'`
-> IPAddressVersion	`$sel:iPAddressVersion:IPSet'`
-> IPSet

Create a value of IPSet 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:description:IPSet', iPSet_description - A description of the IP set that helps with identification.

$sel:name:IPSet', iPSet_name - The name of the IP set. You cannot change the name of an IPSet after you create it.

$sel:id:IPSet', iPSet_id - A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

$sel:arn:IPSet', iPSet_arn - The Amazon Resource Name (ARN) of the entity.

$sel:iPAddressVersion:IPSet', iPSet_iPAddressVersion - The version of the IP addresses, either IPV4 or IPV6.

$sel:addresses:IPSet', iPSet_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

iPSet_description :: Lens' IPSet (Maybe Text) Source #

A description of the IP set that helps with identification.

iPSet_name :: Lens' IPSet Text Source #

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

iPSet_id :: Lens' IPSet Text Source #

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

iPSet_arn :: Lens' IPSet Text Source #

The Amazon Resource Name (ARN) of the entity.

iPSet_iPAddressVersion :: Lens' IPSet IPAddressVersion Source #

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

iPSet_addresses :: Lens' IPSet [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