IAmazonWAFRegional.CreateRule Method (CreateRuleRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateRuleAsync.

Namespace: Amazon.WAFRegional
Assembly: AWSSDK.WAFRegional.dll
Version: 3.x.y.z

Syntax

public abstract CreateRuleResponse CreateRule(
         CreateRuleRequest request
)

Parameters

request: Type: Amazon.WAFRegional.Model.CreateRuleRequest

Container for the necessary parameters to execute the CreateRule service method.

Return Value

Type: CreateRuleResponse

The response from the CreateRule service method, as returned by WAFRegional.

Exceptions

Exception	Condition
WAFBadRequestException
WAFDisallowedNameException	The name specified is invalid.
WAFInternalErrorException	The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidParameterException	The operation failed because AWS WAF didn't recognize a parameter in the request. For example: You specified an invalid parameter name. You specified an invalid value. You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. You tried to create a WebACL with a DefaultActionType other than ALLOW, BLOCK, or COUNT. You tried to create a RateBasedRule with a RateKey value other than IP. You tried to update a WebACL with a WafActionType other than ALLOW, BLOCK, or COUNT. You tried to update a ByteMatchSet with a FieldToMatchType other than HEADER, METHOD, QUERY_STRING, URI, or BODY. You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException	The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
WAFStaleDataException	The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
WAFTagOperationException
WAFTagOperationInternalErrorException

Examples

The following example creates a rule named WAFByteHeaderRule.

To create a rule


var client = new AmazonWAFRegionalClient();
var response = client.CreateRule(new CreateRuleRequest 
{
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    MetricName = "WAFByteHeaderRule",
    Name = "WAFByteHeaderRule"
});

string changeToken = response.ChangeToken;
Rule rule = response.Rule;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

IAmazonWAFRegional.CreateRule (CreateRuleRequest)

Method