waf_create_web_acl: Creates a WebACL, which contains the Rules that identify the...

Description Usage Arguments Details Request syntax Examples

View source: R/waf_operations.R

Description

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.

Usage

1
waf_create_web_acl(Name, MetricName, DefaultAction, ChangeToken, Tags)

Arguments

Name

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

MetricName

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

DefaultAction

[required] 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.

ChangeToken

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

Tags

Details

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.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc$create_web_acl(
  Name = "string",
  MetricName = "string",
  DefaultAction = list(
    Type = "BLOCK"|"ALLOW"|"COUNT"
  ),
  ChangeToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples

1
2
3
4
5
6
7
8
9
# The following example creates a web ACL named CreateExample.
svc$create_web_acl(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  DefaultAction = list(
    Type = "ALLOW"
  ),
  MetricName = "CreateExample",
  Name = "CreateExample"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.