software.amazon.awscdk.services.wafv2

Class CfnIPSetProps.Builder

java.lang.Object

software.amazon.awscdk.services.wafv2.CfnIPSetProps.Builder

Enclosing interface:

CfnIPSetProps

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

A builder for CfnIPSetProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnIPSetProps.Builder	addresses(java.util.List<java.lang.String> addresses) Sets the value of CfnIPSetProps.getAddresses()
CfnIPSetProps	build() Builds the configured instance.
CfnIPSetProps.Builder	description(java.lang.String description) Sets the value of CfnIPSetProps.getDescription()
CfnIPSetProps.Builder	ipAddressVersion(java.lang.String ipAddressVersion) Sets the value of CfnIPSetProps.getIpAddressVersion()
CfnIPSetProps.Builder	name(java.lang.String name) Sets the value of CfnIPSetProps.getName()
CfnIPSetProps.Builder	scope(java.lang.String scope) Sets the value of CfnIPSetProps.getScope()
CfnIPSetProps.Builder	tags(java.util.List<? extends CfnTag> tags) Sets the value of CfnIPSetProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

addresses

public CfnIPSetProps.Builder addresses(java.util.List<java.lang.String> addresses)

Sets the value of CfnIPSetProps.getAddresses()

Parameters:

addresses - Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. This parameter is required. 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

Returns:

this

ipAddressVersion

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

Sets the value of CfnIPSetProps.getIpAddressVersion()

Parameters:

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

Returns:

this

scope

public CfnIPSetProps.Builder scope(java.lang.String scope)

Sets the value of CfnIPSetProps.getScope()

Parameters:

scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. This parameter is required. 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 .

Returns:

this

description

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

Sets the value of CfnIPSetProps.getDescription()

Parameters:

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

Returns:

this

name

public CfnIPSetProps.Builder name(java.lang.String name)

Sets the value of CfnIPSetProps.getName()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnIPSetProps.getTags()

Parameters:

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.

Returns:

this

build

public CfnIPSetProps build()

Builds the configured instance.

Returns:

a new instance of CfnIPSetProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided