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

Class CfnByteMatchSet

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.waf.regional.CfnByteMatchSet
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IByteMatchSetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:52.005Z") @Stability(Stable) public class CfnByteMatchSet extends CfnResource implements IInspectable, IByteMatchSetRef

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

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.*;
 CfnByteMatchSet cfnByteMatchSet = CfnByteMatchSet.Builder.create(this, "MyCfnByteMatchSet")
         .name("name")
         // the properties below are optional
         .byteMatchTuples(List.of(ByteMatchTupleProperty.builder()
                 .fieldToMatch(FieldToMatchProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .data("data")
                         .build())
                 .positionalConstraint("positionalConstraint")
                 .textTransformation("textTransformation")
                 // the properties below are optional
                 .targetString("targetString")
                 .targetStringBase64("targetStringBase64")
                 .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

    • CfnByteMatchSet

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

    • CfnByteMatchSet

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

    • CfnByteMatchSet

      @Stability(Stable) public CfnByteMatchSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnByteMatchSetProps 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getByteMatchSetRef

      @Stability(Stable) @NotNull public ByteMatchSetReference getByteMatchSetRef()
      A reference to a ByteMatchSet resource.
      Specified by:
      getByteMatchSetRef in interface IByteMatchSetRef

    • 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 ByteMatchSet .

    • setName

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

    • getByteMatchTuples

      @Stability(Stable) @Nullable public Object getByteMatchTuples()
      Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnByteMatchSet.ByteMatchTupleProperty>

    • setByteMatchTuples

      @Stability(Stable) public void setByteMatchTuples(@Nullable IResolvable value)
      Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

    • setByteMatchTuples

      @Stability(Stable) public void setByteMatchTuples(@Nullable List<Object> value)
      Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.