software.amazon.awscdk.services.wafv2

Interface CfnIPSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.677Z")
 @Stability(value=Stable)
public interface CfnIPSetProps
extends software.amazon.jsii.JsiiSerializable

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()
List<String>	getAddresses() Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
default String	getDescription() A description of the IP set that helps with identification.
String	getIpAddressVersion() The version of the IP addresses, either `IPV4` or `IPV6` .
default String	getName() The name of the IP set.
String	getScope() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
default List<CfnTag>	getTags() Key:value pairs associated with an AWS resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddresses

@Stability(value=Stable)
 @NotNull
List<String> getAddresses()

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in 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

@Stability(value=Stable)
 @NotNull
String getIpAddressVersion()

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

getScope

@Stability(value=Stable)
 @NotNull
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, or an AWS AppSync GraphQL API. 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

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the IP set that helps with identification.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The name of the IP set.

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

getTags

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
static CfnIPSetProps.Builder builder()

Returns:

a CfnIPSetProps.Builder of CfnIPSetProps