Package software.amazon.awscdk.services.waf

Class CfnXssMatchSet

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.CfnXssMatchSet
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.078Z") @Stability(Stable) public class CfnXssMatchSet extends CfnResource implements IInspectable
A CloudFormation AWS::WAF::XssMatchSet.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnXssMatchSetProps props)
      Create a new AWS::WAF::XssMatchSet.

      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()
      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.

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