Package software.amazon.awscdk.services.waf

Class CfnXssMatchSet

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.CfnXssMatchSet
All Implemented Interfaces:
IInspectable, IXssMatchSetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:48.701Z") @Stability(Stable) public class CfnXssMatchSet extends CfnResource implements IInspectable, IXssMatchSetRef

AWS WAF Classic support will end on September 30, 2025.

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.

A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

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.*;
 CfnXssMatchSet cfnXssMatchSet = CfnXssMatchSet.Builder.create(this, "MyCfnXssMatchSet")
         .name("name")
         .xssMatchTuples(List.of(XssMatchTupleProperty.builder()
                 .fieldToMatch(FieldToMatchProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .data("data")
                         .build())
                 .textTransformation("textTransformation")
                 .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

    • CfnXssMatchSet

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

    • CfnXssMatchSet

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

    • CfnXssMatchSet

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

    • getCfnProperties

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

    • getXssMatchSetRef

      @Stability(Stable) @NotNull public XssMatchSetReference getXssMatchSetRef()
      A reference to a XssMatchSet resource.
      Specified by:
      getXssMatchSetRef in interface IXssMatchSetRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name, if any, of the XssMatchSet .

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name, if any, of the XssMatchSet .

    • getXssMatchTuples

      @Stability(Stable) @NotNull public Object getXssMatchTuples()
      Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnXssMatchSet.XssMatchTupleProperty>

    • setXssMatchTuples

      @Stability(Stable) public void setXssMatchTuples(@NotNull IResolvable value)
      Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    • setXssMatchTuples

      @Stability(Stable) public void setXssMatchTuples(@NotNull List<Object> value)
      Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.