Class CfnIPSetMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnIPSetMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIPSetMixinProps>
- Enclosing interface:
CfnIPSetMixinProps
@Stability(Stable)
public static final class CfnIPSetMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIPSetMixinProps>
A builder for
CfnIPSetMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnIPSetMixinProps.getAddresses()build()Builds the configured instance.description(String description) Sets the value ofCfnIPSetMixinProps.getDescription()ipAddressVersion(String ipAddressVersion) Sets the value ofCfnIPSetMixinProps.getIpAddressVersion()Sets the value ofCfnIPSetMixinProps.getName()Sets the value ofCfnIPSetMixinProps.getScope()Sets the value ofCfnIPSetMixinProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
addresses
Sets the value ofCfnIPSetMixinProps.getAddresses()- 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. 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
Addressesspecifications:- 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
- For requests that originated from the IP address 192.0.2.44, specify
- Returns:
this
-
description
Sets the value ofCfnIPSetMixinProps.getDescription()- Parameters:
description- A description of the IP set that helps with identification.- Returns:
this
-
ipAddressVersion
Sets the value ofCfnIPSetMixinProps.getIpAddressVersion()- Parameters:
ipAddressVersion- The version of the IP addresses, eitherIPV4orIPV6.- Returns:
this
-
name
Sets the value ofCfnIPSetMixinProps.getName()- Parameters:
name- The name of the IP set. You cannot change the name of anIPSetafter you create it.- Returns:
this
-
scope
Sets the value ofCfnIPSetMixinProps.getScope()- Parameters:
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 areCLOUDFRONTandREGIONAL.For
CLOUDFRONT, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1.- Returns:
this
-
tags
Sets the value ofCfnIPSetMixinProps.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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnIPSetMixinProps>- Returns:
- a new instance of
CfnIPSetMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-