software.amazon.awscdk.services.wafv2

Interface CfnIPSetProps

All Known Implementing Classes:

CfnIPSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:19.617Z")
public interface CfnIPSetProps

Properties for defining a `CfnIPSet`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 CfnIPSetProps cfnIPSetProps = CfnIPSetProps.builder()
         .addresses(List.of("addresses"))
         .ipAddressVersion("ipAddressVersion")
         .scope("scope")
         // the properties below are optional
         .description("description")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIPSetProps.Builder A builder for CfnIPSetProps
static class	CfnIPSetProps.Jsii$Proxy An implementation for CfnIPSetProps

Method Summary

Modifier and Type	Method and Description
static CfnIPSetProps.Builder	builder()
java.util.List<java.lang.String>	getAddresses() Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses.
default java.lang.String	getDescription() A description of the IP set that helps with identification.
java.lang.String	getIpAddressVersion() The version of the IP addresses, either `IPV4` or `IPV6` .
default java.lang.String	getName() The name of the IP set.
java.lang.String	getScope() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
default java.util.List<CfnTag>	getTags() Key:value pairs associated with an AWS resource.

Method Detail

getAddresses

java.util.List<java.lang.String> getAddresses()

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

getIpAddressVersion

java.lang.String getIpAddressVersion()

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

getScope

java.lang.String getScope()

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 .

getDescription

default java.lang.String getDescription()

A description of the IP set that helps with identification.

getName

default java.lang.String getName()

The name of the IP set.

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

getTags

default java.util.List<CfnTag> getTags()

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.

builder

static CfnIPSetProps.Builder builder()

Returns:

a CfnIPSetProps.Builder of CfnIPSetProps