paws.security.identity (version 0.1.6)

waf_create_rule: Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block

Description

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:

Usage

waf_create_rule(Name, MetricName, ChangeToken, Tags)

Arguments

Name

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

MetricName

[required] A friendly name or description for the metrics for this Rule. 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 Rule.

ChangeToken

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

Tags

Request syntax

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

Details

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

1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

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

3. Submit a CreateRule request.

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

5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

6. 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.

Examples

# NOT RUN {
# The following example creates a rule named WAFByteHeaderRule.
# }
# NOT RUN {
svc$create_rule(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  MetricName = "WAFByteHeaderRule",
  Name = "WAFByteHeaderRule"
)
# }
# NOT RUN {
# }