Package software.amazon.awscdk.mixins.preview.services.wafv2.mixins

Class CfnIPSetPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.wafv2.mixins.CfnIPSetPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIPSetPropsMixin>

Enclosing class:

CfnIPSetPropsMixin

@Stability(Stable)
public static final class CfnIPSetPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIPSetPropsMixin>

A fluent builder for CfnIPSetPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnIPSetPropsMixin.Builder	addresses(List<String> addresses)	Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests.
CfnIPSetPropsMixin	build()
static CfnIPSetPropsMixin.Builder	create()
static CfnIPSetPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnIPSetPropsMixin.Builder	description(String description)	A description of the IP set that helps with identification.
CfnIPSetPropsMixin.Builder	ipAddressVersion(String ipAddressVersion)	The version of the IP addresses, either IPV4 or IPV6 .
CfnIPSetPropsMixin.Builder	name(String name)	The name of the IP set.
CfnIPSetPropsMixin.Builder	scope(String scope)	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
CfnIPSetPropsMixin.Builder	tags(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 Details

create

@Stability(Stable)
public static CfnIPSetPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnIPSetPropsMixin.Builder.

create

@Stability(Stable)
public static CfnIPSetPropsMixin.Builder create()

Returns:

a new instance of CfnIPSetPropsMixin.Builder.

addresses

@Stability(Stable)
public CfnIPSetPropsMixin.Builder addresses(List<String> addresses)

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests.

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:

• 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 AWS WAF to inspect for in incoming requests. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-addresses

description

@Stability(Stable)
public CfnIPSetPropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-description

ipAddressVersion

@Stability(Stable)
public CfnIPSetPropsMixin.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 . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-ipaddressversion

name

@Stability(Stable)
public CfnIPSetPropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-name

scope

@Stability(Stable)
public CfnIPSetPropsMixin.Builder scope(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 REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-scope

tags

@Stability(Stable)
public CfnIPSetPropsMixin.Builder tags(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-tags

build

@Stability(Stable)
public CfnIPSetPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnIPSetPropsMixin>

Returns:

a newly built instance of CfnIPSetPropsMixin.