AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateRule operation.
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 WAFV2 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.
Creates a Rule
, which contains the IPSet
objects, ByteMatchSet
objects, and other predicates that identify the requests that you want to block. If
you add more than one predicate to a Rule
, a request must match all of the
specifications to be allowed or blocked. For example, suppose that you add the following
to a Rule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
You then add the Rule
to a WebACL
and specify that you want to blocks
requests that satisfy the Rule
. For a request to be blocked, it must come from
the IP address 192.0.2.44 and the User-Agent
header in the request must
contain the value BadBot
.
To create and configure a Rule
, perform the following steps:
Create and update the predicates that you want to include in the Rule
. For
more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateRule
request.
Submit a CreateRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to specify the predicates that you want to include
in the Rule
.
Create and update a WebACL
that contains the Rule
. For more information,
see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
Namespace: Amazon.WAF.Model
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z
public class CreateRuleRequest : AmazonWAFRequest IAmazonWebServiceRequest
The CreateRuleRequest type exposes the following members
Name | Description | |
---|---|---|
CreateRuleRequest() |
Name | Type | Description | |
---|---|---|---|
ChangeToken | System.String |
Gets and sets the property ChangeToken. The value returned by the most recent call to GetChangeToken. |
|
MetricName | System.String |
Gets and sets the property MetricName.
A friendly name or description for the metrics for this |
|
Name | System.String |
Gets and sets the property Name.
A friendly name or description of the Rule. You can't change the name of a
|
|
Tags | System.Collections.Generic.List<Amazon.WAF.Model.Tag> |
Gets and sets the property Tags. |
The following example creates a rule named WAFByteHeaderRule.
var client = new AmazonWAFClient(); var response = client.CreateRule(new CreateRuleRequest { ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", MetricName = "WAFByteHeaderRule", Name = "WAFByteHeaderRule" }); string changeToken = response.ChangeToken; Rule rule = response.Rule;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5