software.amazon.awscdk.services.waf.regional

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.regional.CfnXssMatchSet

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.673Z")
 @Stability(value=Stable)
public class CfnXssMatchSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::WAFRegional::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.regional.*;
 CfnXssMatchSet cfnXssMatchSet = CfnXssMatchSet.Builder.create(this, "MyCfnXssMatchSet")
         .name("name")
         // the properties below are optional
         .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 AWS WAF to inspect, such as a specific header or a query string.
static interface	CfnXssMatchSet.XssMatchTupleProperty > This is *AWS WAF Classic* documentation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnXssMatchSet(software.constructs.Construct scope, String id, CfnXssMatchSetProps props) Create a new `AWS::WAFRegional::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 Map<String,Object>	getCfnProperties()
String	getName() The name, if any, of the `XssMatchSet` .
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(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(List<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.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnXssMatchSet(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnXssMatchSetProps props)

Create a new `AWS::WAFRegional::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

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

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

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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

getXssMatchTuples

@Stability(value=Stable)
 @Nullable
public Object getXssMatchTuples()

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

setXssMatchTuples

@Stability(value=Stable)
public void setXssMatchTuples(@Nullable
                                                       IResolvable value)

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

setXssMatchTuples

@Stability(value=Stable)
public void setXssMatchTuples(@Nullable
                                                       List<Object> value)

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