Skip to content

Create Rule Group

waf_create_rule_group R Documentation

This is AWS WAF Classic documentation

Description

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 RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use update_rule_group to add rules to the rule group.

Rule groups are subject to the following limits:

  • Three rule groups per account. You can request an increase to this limit by contacting customer support.

  • One rule group per web ACL.

  • Ten rules per rule group.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Usage

waf_create_rule_group(Name, MetricName, ChangeToken, Tags)

Arguments

Name

[required] A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.

MetricName

[required] A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.

ChangeToken

[required] The value returned by the most recent call to get_change_token.

Tags

Value

A list with the following syntax: 

list(
  RuleGroup = list(
    RuleGroupId = "string",
    Name = "string",
    MetricName = "string"
  ),
  ChangeToken = "string"
)

Request syntax

svc$create_rule_group(
  Name = "string",
  MetricName = "string",
  ChangeToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)