@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:40.370Z") public class CfnRule 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.
A combination of ByteMatchSet
, IPSet
, and/or SqlInjectionMatchSet
objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule
that includes the following predicates:
IPSet
that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
ByteMatchSet
that causes AWS WAF to search for web requests for which the value of the User-Agent
header is BadBot
.
To match the settings in this Rule
, a request must originate from 192.0.2.44
AND include a User-Agent
header for which the value is BadBot
.
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.*; CfnRule cfnRule = CfnRule.Builder.create(this, "MyCfnRule") .metricName("metricName") .name("name") // the properties below are optional .predicates(List.of(PredicateProperty.builder() .dataId("dataId") .negated(false) .type("type") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnRule.Builder
A fluent builder for
CfnRule . |
static interface |
CfnRule.PredicateProperty
Specifies the `ByteMatchSet` , `IPSet` , `SqlInjectionMatchSet` , `XssMatchSet` , `RegexMatchSet` , `GeoMatchSet` , and `SizeConstraintSet` objects that you want to add to a `Rule` and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.
|
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 |
---|---|
|
CfnRule(Construct scope,
java.lang.String id,
CfnRuleProps props)
Create a new `AWS::WAF::Rule`.
|
protected |
CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnRule(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getMetricName()
The name of the metrics for this `Rule` .
|
java.lang.String |
getName()
The friendly name or description for the `Rule` .
|
java.lang.Object |
getPredicates()
The `Predicates` object contains one `Predicate` element for each `ByteMatchSet` , `IPSet` , or `SqlInjectionMatchSet` object that you want to include in a `Rule` .
|
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 |
setMetricName(java.lang.String value)
The name of the metrics for this `Rule` .
|
void |
setName(java.lang.String value)
The friendly name or description for the `Rule` .
|
void |
setPredicates(IResolvable value)
The `Predicates` object contains one `Predicate` element for each `ByteMatchSet` , `IPSet` , or `SqlInjectionMatchSet` object that you want to include in a `Rule` .
|
void |
setPredicates(java.util.List<java.lang.Object> value)
The `Predicates` object contains one `Predicate` element for each `ByteMatchSet` , `IPSet` , or `SqlInjectionMatchSet` object that you want to include in a `Rule` .
|
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 CfnRule(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnRule(Construct scope, java.lang.String id, CfnRuleProps 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 getMetricName()
The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF , including "All" and "Default_Action." You can't change MetricName
after you create the Rule
.
public void setMetricName(java.lang.String value)
The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF , including "All" and "Default_Action." You can't change MetricName
after you create the Rule
.
public java.lang.String getName()
You can't change the name of a Rule
after you create it.
public void setName(java.lang.String value)
You can't change the name of a Rule
after you create it.
public java.lang.Object getPredicates()
public void setPredicates(IResolvable value)
public void setPredicates(java.util.List<java.lang.Object> value)