Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateWebACLCommand

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 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:

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.
Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.
Submit a CreateWebACL request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WAFClient, CreateWebACLCommand } from "@aws-sdk/client-waf"; // ES Modules import
// const { WAFClient, CreateWebACLCommand } = require("@aws-sdk/client-waf"); // CommonJS import
const client = new WAFClient(config);
const input = { // CreateWebACLRequest
  Name: "STRING_VALUE", // required
  MetricName: "STRING_VALUE", // required
  DefaultAction: { // WafAction
    Type: "BLOCK" || "ALLOW" || "COUNT", // required
  },
  ChangeToken: "STRING_VALUE", // required
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateWebACLCommand(input);
const response = await client.send(command);
// { // CreateWebACLResponse
//   WebACL: { // WebACL
//     WebACLId: "STRING_VALUE", // required
//     Name: "STRING_VALUE",
//     MetricName: "STRING_VALUE",
//     DefaultAction: { // WafAction
//       Type: "BLOCK" || "ALLOW" || "COUNT", // required
//     },
//     Rules: [ // ActivatedRules // required
//       { // ActivatedRule
//         Priority: Number("int"), // required
//         RuleId: "STRING_VALUE", // required
//         Action: {
//           Type: "BLOCK" || "ALLOW" || "COUNT", // required
//         },
//         OverrideAction: { // WafOverrideAction
//           Type: "NONE" || "COUNT", // required
//         },
//         Type: "REGULAR" || "RATE_BASED" || "GROUP",
//         ExcludedRules: [ // ExcludedRules
//           { // ExcludedRule
//             RuleId: "STRING_VALUE", // required
//           },
//         ],
//       },
//     ],
//     WebACLArn: "STRING_VALUE",
//   },
//   ChangeToken: "STRING_VALUE",
// };

Example Usage

Loading code editor