software.amazon.awssdk.services.wafv2.model

Interface IPSet.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IPSet.Builder,IPSet>, SdkBuilder<IPSet.Builder,IPSet>, SdkPojo

Enclosing class:

IPSet

public static interface IPSet.Builder
extends SdkPojo, CopyableBuilder<IPSet.Builder,IPSet>

Method Summary

Modifier and Type	Method and Description
IPSet.Builder	addresses(Collection<String> 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.
IPSet.Builder	addresses(String... 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.
IPSet.Builder	arn(String arn) The Amazon Resource Name (ARN) of the entity.
IPSet.Builder	description(String description) A description of the IP set that helps with identification.
IPSet.Builder	id(String id) A unique identifier for the set.
IPSet.Builder	ipAddressVersion(IPAddressVersion ipAddressVersion) The version of the IP addresses, either IPV4 or IPV6.
IPSet.Builder	ipAddressVersion(String ipAddressVersion) The version of the IP addresses, either IPV4 or IPV6.
IPSet.Builder	name(String name) The name of the IP set.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

IPSet.Builder name(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

id

IPSet.Builder id(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

IPSet.Builder arn(String arn)

The Amazon Resource Name (ARN) of the entity.

Parameters:

arn - The Amazon Resource Name (ARN) of the entity.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

IPSet.Builder description(String description)

A description of the IP set that helps with identification.

Parameters:

description - A description of the IP set that helps with identification.

Returns:

Returns a reference to this object so that method calls can be chained together.

ipAddressVersion

IPSet.Builder ipAddressVersion(String ipAddressVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IPAddressVersion, IPAddressVersion

ipAddressVersion

IPSet.Builder ipAddressVersion(IPAddressVersion ipAddressVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IPAddressVersion, IPAddressVersion

addresses

IPSet.Builder addresses(Collection<String> 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addresses

IPSet.Builder addresses(String... 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.