software.amazon.awscdk.services.waf

Class CfnXssMatchSet

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.396Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnXssMatchSet.Builder A fluent builder for CfnXssMatchSet.
static interface	CfnXssMatchSet.FieldToMatchProperty The part of a web request that you want to inspect, such as a specified header or a query string.
static interface	CfnXssMatchSet.XssMatchTupleProperty > This is *AWS WAF Classic* documentation.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnXssMatchSet(Construct scope, java.lang.String id, CfnXssMatchSetProps props) Create a new `AWS::WAF::XssMatchSet`.
protected	CfnXssMatchSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnXssMatchSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() The name, if any, of the `XssMatchSet` .
java.lang.Object	getXssMatchTuples() Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.String value) The name, if any, of the `XssMatchSet` .
void	setXssMatchTuples(IResolvable value) Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
void	setXssMatchTuples(java.util.List<java.lang.Object> value) Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnXssMatchSet

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

CfnXssMatchSet

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

CfnXssMatchSet

public CfnXssMatchSet(Construct scope,
                      java.lang.String id,
                      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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

public java.lang.String getName()

The name, if any, of the `XssMatchSet` .

setName

public void setName(java.lang.String value)

The name, if any, of the `XssMatchSet` .

getXssMatchTuples

public java.lang.Object getXssMatchTuples()

Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

setXssMatchTuples

public void setXssMatchTuples(IResolvable value)

Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

setXssMatchTuples

public void setXssMatchTuples(java.util.List<java.lang.Object> value)

Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.