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

Interface CfnByteMatchSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnByteMatchSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:52.019Z")
@Stability(Stable)
public interface CfnByteMatchSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnByteMatchSet.

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.*;
 CfnByteMatchSetProps cfnByteMatchSetProps = CfnByteMatchSetProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnByteMatchSetProps.Builder	builder()
default 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.
String	getName()	A friendly name or description of the ByteMatchSet .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A friendly name or description of the ByteMatchSet .

You can't change Name after you create a ByteMatchSet .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-name

getByteMatchTuples

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-bytematchtuples

builder

@Stability(Stable)
static CfnByteMatchSetProps.Builder builder()

Returns:

a CfnByteMatchSetProps.Builder of CfnByteMatchSetProps