Package software.amazon.awscdk.services.waf.regional

Class CfnIPSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.waf.regional.CfnIPSet
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.093Z") @Stability(Stable) public class CfnIPSet extends CfnResource implements IInspectable
A CloudFormation AWS::WAFRegional::IPSet.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.

To specify an individual IP address, you specify the four-part IP address followed by a /32 , for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing .

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.waf.regional.*;
 CfnIPSet cfnIPSet = CfnIPSet.Builder.create(this, "MyCfnIPSet")
         .name("name")
         // the properties below are optional
         .ipSetDescriptors(List.of(Map.of(
                 "type", "type",
                 "value", "value")))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIPSet

      protected CfnIPSet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIPSet

      protected CfnIPSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIPSet

      @Stability(Stable) public CfnIPSet(@NotNull Construct scope, @NotNull String id, @NotNull CfnIPSetProps props)
      Create a new AWS::WAFRegional::IPSet.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      A friendly name or description of the IPSet .

      You can't change the name of an IPSet after you create it.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A friendly name or description of the IPSet .

      You can't change the name of an IPSet after you create it.

    • getIpSetDescriptors

      @Stability(Stable) @Nullable public Object getIpSetDescriptors()
      The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) that web requests originate from.

    • setIpSetDescriptors

      @Stability(Stable) public void setIpSetDescriptors(@Nullable IResolvable value)
      The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) that web requests originate from.

    • setIpSetDescriptors

      @Stability(Stable) public void setIpSetDescriptors(@Nullable List<Object> value)
      The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) that web requests originate from.