/AWS1/CL_WA2=>CREATEWEBACL()

About CreateWebACL

Creates a WebACL per the specifications provided.

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

Method Signature

IMPORTING

Required arguments:

IV_NAME TYPE /AWS1/WA2ENTITYNAME /AWS1/WA2ENTITYNAME

The name of the web ACL. You cannot change the name of a web ACL after you create it.

IV_SCOPE TYPE /AWS1/WA2SCOPE /AWS1/WA2SCOPE

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

IO_DEFAULTACTION TYPE REF TO /AWS1/CL_WA2DEFAULTACTION /AWS1/CL_WA2DEFAULTACTION

The action to perform if none of the Rules contained in the WebACL match.

IO_VISIBILITYCONFIG TYPE REF TO /AWS1/CL_WA2VISIBILITYCONFIG /AWS1/CL_WA2VISIBILITYCONFIG

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/WA2ENTITYDESCRIPTION /AWS1/WA2ENTITYDESCRIPTION

A description of the web ACL that helps with identification.

IT_RULES TYPE /AWS1/CL_WA2RULE=>TT_RULES TT_RULES

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching
web requests, and parameters that govern how WAF handles them.

IT_TAGS TYPE /AWS1/CL_WA2TAG=>TT_TAGLIST TT_TAGLIST

An array of key:value pairs to associate with the resource.

IT_CUSTOMRESPONSEBODIES TYPE /AWS1/CL_WA2CUSTOMRESPONSEBODY=>TT_CUSTOMRESPONSEBODIES TT_CUSTOMRESPONSEBODIES

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

IO_CAPTCHACONFIG TYPE REF TO /AWS1/CL_WA2CAPTCHACONFIG /AWS1/CL_WA2CAPTCHACONFIG

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

IO_CHALLENGECONFIG TYPE REF TO /AWS1/CL_WA2CHALLENGECONFIG /AWS1/CL_WA2CHALLENGECONFIG

Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

IT_TOKENDOMAINS TYPE /AWS1/CL_WA2TOKENDOMAINS_W=>TT_TOKENDOMAINS TT_TOKENDOMAINS

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

IO_ASSOCIATIONCONFIG TYPE REF TO /AWS1/CL_WA2ASSOCIATIONCONFIG /AWS1/CL_WA2ASSOCIATIONCONFIG

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_WA2CREATEWEBACLRSP /AWS1/CL_WA2CREATEWEBACLRSP