@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:50.668Z") public class CfnByteMatchSet extends CfnResource implements IInspectable
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.
The AWS::WAFRegional::ByteMatchSet
resource creates an AWS WAF ByteMatchSet
that identifies a part of a web request that you want to inspect.
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.*; CfnByteMatchSet cfnByteMatchSet = CfnByteMatchSet.Builder.create(this, "MyCfnByteMatchSet") .name("name") // the properties below are optional .byteMatchTuples(List.of(ByteMatchTupleProperty.builder() .fieldToMatch(FieldToMatchProperty.builder() .type("type") // the properties below are optional .data("data") .build()) .positionalConstraint("positionalConstraint") .textTransformation("textTransformation") // the properties below are optional .targetString("targetString") .targetStringBase64("targetStringBase64") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnByteMatchSet.Builder
A fluent builder for
CfnByteMatchSet . |
static interface |
CfnByteMatchSet.ByteMatchTupleProperty
> This is *AWS WAF Classic* documentation.
|
static interface |
CfnByteMatchSet.FieldToMatchProperty
> This is *AWS WAF Classic* documentation.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnByteMatchSet(Construct scope,
java.lang.String id,
CfnByteMatchSetProps props)
Create a new `AWS::WAFRegional::ByteMatchSet`.
|
protected |
CfnByteMatchSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnByteMatchSet(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getByteMatchTuples()
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getName()
A friendly name or description of the `ByteMatchSet` .
|
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 |
setByteMatchTuples(IResolvable value)
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
|
void |
setByteMatchTuples(java.util.List<java.lang.Object> value)
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
|
void |
setName(java.lang.String value)
A friendly name or description of the `ByteMatchSet` .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnByteMatchSet(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnByteMatchSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnByteMatchSet(Construct scope, java.lang.String id, CfnByteMatchSetProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
You can't change Name
after you create a ByteMatchSet
.
public void setName(java.lang.String value)
You can't change Name
after you create a ByteMatchSet
.
public java.lang.Object getByteMatchTuples()
public void setByteMatchTuples(IResolvable value)
public void setByteMatchTuples(java.util.List<java.lang.Object> value)