software.amazon.awscdk.services.wafv2

Class CfnIPSet.Builder

java.lang.Object

software.amazon.awscdk.services.wafv2.CfnIPSet.Builder

Enclosing class:

CfnIPSet

public static final class CfnIPSet.Builder
extends java.lang.Object

A fluent builder for CfnIPSet.

Method Summary

Modifier and Type	Method and Description
CfnIPSet.Builder	addresses(java.util.List<java.lang.String> addresses) Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses.
CfnIPSet	build()
static CfnIPSet.Builder	create(Construct scope, java.lang.String id)
CfnIPSet.Builder	description(java.lang.String description) A description of the IP set that helps with identification.
CfnIPSet.Builder	ipAddressVersion(java.lang.String ipAddressVersion) The version of the IP addresses, either `IPV4` or `IPV6` .
CfnIPSet.Builder	name(java.lang.String name) The name of the IP set.
CfnIPSet.Builder	scope(java.lang.String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
CfnIPSet.Builder	tags(java.util.List<? extends CfnTag> tags) Key:value pairs associated with an AWS resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnIPSet.Builder create(Construct scope,
                                      java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnIPSet.Builder.

addresses

public CfnIPSet.Builder addresses(java.util.List<java.lang.String> 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. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0 .

Example address strings:

• To configure AWS 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 AWS 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 AWS 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 AWS 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

Parameters:

addresses - Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. This parameter is required.

Returns:

this

ipAddressVersion

public CfnIPSet.Builder ipAddressVersion(java.lang.String ipAddressVersion)

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

Parameters:

ipAddressVersion - The version of the IP addresses, either `IPV4` or `IPV6` . This parameter is required.

Returns:

this

scope

public CfnIPSet.Builder scope(java.lang.String 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 AWS AppSync GraphQL API, an Amazon Cognito user pool, or an AWS App Runner service. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

Parameters:

scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. This parameter is required.

Returns:

this

description

public CfnIPSet.Builder description(java.lang.String description)

A description of the IP set that helps with identification.

Parameters:

description - A description of the IP set that helps with identification. This parameter is required.

Returns:

this

name

public CfnIPSet.Builder name(java.lang.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. This parameter is required.

Returns:

this

tags

public CfnIPSet.Builder tags(java.util.List<? extends CfnTag> tags)

Key:value pairs associated with an AWS resource.

The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

Parameters:

tags - Key:value pairs associated with an AWS resource. This parameter is required.

Returns:

this

build

public CfnIPSet build()