AWS SDK Version 3 for .NET
API Reference

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 CreateWebACL operation. Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

To create and configure a WebACL, perform the following steps:

  1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

  2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

  4. Submit a CreateWebACL request.

  5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

  6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.WAF.AmazonWAFRequest
      Amazon.WAF.Model.CreateWebACLRequest

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

Syntax

C#
public class CreateWebACLRequest : AmazonWAFRequest
         IAmazonWebServiceRequest

The CreateWebACLRequest type exposes the following members

Constructors

NameDescription
Public Method CreateWebACLRequest()

Properties

NameTypeDescription
Public Property ChangeToken System.String

Gets and sets the property ChangeToken.

The value returned by the most recent call to GetChangeToken.

Public Property DefaultAction Amazon.WAF.Model.WafAction

Gets and sets the property DefaultAction.

The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

Public Property MetricName System.String

Gets and sets the property MetricName.

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

Public Property Name System.String

Gets and sets the property Name.

A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

Examples

The following example creates a web ACL named CreateExample.

To create a web ACL


var response = client.CreateWebACL(new CreateWebACLRequest 
{
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    DefaultAction = new WafAction { Type = "ALLOW" },
    MetricName = "CreateExample",
    Name = "CreateExample"
});

string changeToken = response.ChangeToken;
WebACL webACL = response.WebACL;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms