Class CfnXssMatchSet
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
Deprecation notice: 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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnXssMatchSet
.static interface
The part of a web request that you want to inspect, such as a specified header or a query string.static interface
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnXssMatchSet
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnXssMatchSet
(software.amazon.jsii.JsiiObjectRef objRef) CfnXssMatchSet
(software.constructs.Construct scope, String id, CfnXssMatchSetProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetName()
The name, if any, of theXssMatchSet
.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.renderProperties
(Map<String, Object> props) void
The name, if any, of theXssMatchSet
.void
setXssMatchTuples
(List<Object> value) Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.void
setXssMatchTuples
(IResolvable 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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
The name, if any, of theXssMatchSet
. -
setName
The name, if any, of theXssMatchSet
. -
getXssMatchTuples
Specifies the parts of web requests that you want to inspect for cross-site scripting attacks. -
setXssMatchTuples
Specifies the parts of web requests that you want to inspect for cross-site scripting attacks. -
setXssMatchTuples
Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
-