AWS WAFV2

Get IP set

Retrieve an IP set.

Inputs

Field

Type

Description

region [required]

enum

default: Global (Cloudfront)

ipSetId [required]

string

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.

ipSetName [required]

string

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

scope

enum

DEPRECATED: Specify whether this is for an Amazon CloudFront distribution or for a regional application. A CloudFront application must use us-east-1 as its region. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API. Allowed enum values: CLOUDFRONT,REGIONAL

Outputs

Expand All

Field

Type

Description

ipSet

object

One or more IP addresses or blocks of IP addresses, specified in CIDR notation.

Name [required]

string

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

Id [required]

string

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 [required]

string

The Amazon Resource Name (ARN) of the entity.

Description

string

A description of the IP set that helps with identification.

IPAddressVersion [required]

string

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

Addresses [required]

[string]

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in 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

amzRequestId [required]

string