Package software.amazon.awscdk.services.wafv2

Class CfnIPSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wafv2.CfnIPSet
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:14.907Z") @Stability(Stable) public class CfnIPSet extends CfnResource implements IInspectable, ITaggable

This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

Use an IPSet to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IP set that lists those IP addresses.

You use an IP set by providing its Amazon Resource Name (ARN) to the rule statement IPSetReferenceStatement , when you add a rule to a rule group or web ACL.

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.*;
 CfnIPSet cfnIPSet = CfnIPSet.Builder.create(this, "MyCfnIPSet")
         .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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPSetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the IP set.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the IP set.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAddresses

      @Stability(Stable) @NotNull public List<String> getAddresses()
      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.

    • setAddresses

      @Stability(Stable) public void setAddresses(@NotNull List<String> value)
      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.

    • getIpAddressVersion

      @Stability(Stable) @NotNull public String getIpAddressVersion()
      The version of the IP addresses, either IPV4 or IPV6 .

    • setIpAddressVersion

      @Stability(Stable) public void setIpAddressVersion(@NotNull String value)
      The version of the IP addresses, either IPV4 or IPV6 .

    • getScope

      @Stability(Stable) @NotNull public String getScope()
      Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

    • setScope

      @Stability(Stable) public void setScope(@NotNull String value)
      Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the IP set that helps with identification.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the IP set that helps with identification.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the IP set.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the IP set.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key:value pairs associated with an AWS resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key:value pairs associated with an AWS resource.