Skip to content

/AWS1/CL_WA2IPSET

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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/WA2ENTITYNAME /AWS1/WA2ENTITYNAME

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

iv_id TYPE /AWS1/WA2ENTITYID /AWS1/WA2ENTITYID

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.

iv_arn TYPE /AWS1/WA2RESOURCEARN /AWS1/WA2RESOURCEARN

The Amazon Resource Name (ARN) of the entity.

iv_ipaddressversion TYPE /AWS1/WA2IPADDRESSVERSION /AWS1/WA2IPADDRESSVERSION

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

it_addresses TYPE /AWS1/CL_WA2IPADDRESSES_W=>TT_IPADDRESSES TT_IPADDRESSES

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. 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:

  • For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • For 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.

  • For 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

Optional arguments:

iv_description TYPE /AWS1/WA2ENTITYDESCRIPTION /AWS1/WA2ENTITYDESCRIPTION

A description of the IP set that helps with identification.

Queryable Attributes

Name

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

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

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.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

ARN

The Amazon Resource Name (ARN) of the entity.

Accessible with the following methods

Method Description
GET_ARN() Getter for ARN, with configurable default
ASK_ARN() Getter for ARN w/ exceptions if field has no value
HAS_ARN() Determine if ARN has a value

Description

A description of the IP set that helps with identification.

Accessible with the following methods

Method Description
GET_DESCRIPTION() Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION() Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION() Determine if DESCRIPTION has a value

IPAddressVersion

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

Accessible with the following methods

Method Description
GET_IPADDRESSVERSION() Getter for IPADDRESSVERSION, with configurable default
ASK_IPADDRESSVERSION() Getter for IPADDRESSVERSION w/ exceptions if field has no va
HAS_IPADDRESSVERSION() Determine if IPADDRESSVERSION has a value

Addresses

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. 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:

  • For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • For 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.

  • For 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

Accessible with the following methods

Method Description
GET_ADDRESSES() Getter for ADDRESSES, with configurable default
ASK_ADDRESSES() Getter for ADDRESSES w/ exceptions if field has no value
HAS_ADDRESSES() Determine if ADDRESSES has a value