Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-wafv2-webacl.json
Parent schema serverless-framework-configuration
Type: object

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git

Properties

DefaultAction object required

Default Action WebACL will take against ingress traffic when there is no matching Rule.

2 nested properties
Allow object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
Block object

Block traffic towards application.

1 nested properties
CustomResponse object

Custom response.

3 nested properties
ResponseCode integer required

Custom response code.

min=200max=599
CustomResponseBodyKey string | Aws_CF_FunctionString

Custom response body key.

ResponseHeaders CustomHTTPHeader[]

Collection of HTTP headers.

minItems=1
Scope string | Aws_CF_FunctionString required

Use CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.

VisibilityConfig object required

Visibility Metric of the WebACL.

3 nested properties
SampledRequestsEnabled boolean required
CloudWatchMetricsEnabled boolean required
MetricName string | Aws_CF_FunctionString required
Description string | Aws_CF_FunctionString

Description of the entity.

Name string | Aws_CF_FunctionString

Name of the WebACL.

Rules Rule[]

Collection of Rules.

Tags Tag[]
minItems=1
CustomResponseBodies object

Custom response key and body map.

CaptchaConfig object
1 nested properties
ImmunityTimeProperty object
1 nested properties
ImmunityTime integer required
min=60max=259200
ChallengeConfig object
1 nested properties
ImmunityTimeProperty object
1 nested properties
ImmunityTime integer required
min=60max=259200
TokenDomains string[]

List of domains to accept in web request tokens, in addition to the domain of the protected resource.

Definitions

AndStatement object
Statements Statement[] required
Body object

The body of a web request. This immediately follows the request headers.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

ByteMatchStatement object

Byte Match statement.

FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
1 nested properties
Name string | Aws_CF_FunctionString required
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required
AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

1 nested properties
OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

4 nested properties
MatchPattern object required

The pattern to look for in the JSON body.

MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Headers object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request headers.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request cookies.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

TextTransformations TextTransformation[] required
PositionalConstraint string | Aws_CF_FunctionString required

Position of the evaluation in the FieldToMatch of request.

SearchString string | Aws_CF_FunctionString

String that is searched to find a match.

SearchStringBase64 string | Aws_CF_FunctionString

Base64 encoded string that is searched to find a match.

DefaultAction object

Default Action WebACL will take against ingress traffic when there is no matching Rule.

Allow object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
Block object

Block traffic towards application.

1 nested properties
CustomResponse object

Custom response.

3 nested properties
ResponseCode integer required

Custom response code.

min=200max=599
CustomResponseBodyKey string | Aws_CF_FunctionString

Custom response body key.

ResponseHeaders CustomHTTPHeader[]

Collection of HTTP headers.

minItems=1
EntityDescription string | Aws_CF_FunctionString

Description of the entity.

EntityName string | Aws_CF_FunctionString

Name of the WebACL.

ExcludedRule object

Excluded Rule in the RuleGroup or ManagedRuleGroup will not be evaluated.

Name string | Aws_CF_FunctionString required

Name of the WebACL.

RuleActionOverride object

Action override for rules in the rule group.

Name string | Aws_CF_FunctionString required

Name of the WebACL.

ActionToUse object required

Action taken when Rule matches its condition.

5 nested properties
Allow object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

Block object

Block traffic towards application.

1 nested properties
CustomResponse object

Custom response.

Count object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

Captcha object

Checks valid token exists with request.

1 nested properties
CustomRequestHandling object

Custom request handling.

Challenge object

Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.

1 nested properties
CustomRequestHandling object

Custom request handling.

ExcludedRules ExcludedRule[]
FieldToMatch object

Field of the request to match.

SingleHeader object
1 nested properties
Name string | Aws_CF_FunctionString required
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required
AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

1 nested properties
OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

4 nested properties
MatchPattern object required

The pattern to look for in the JSON body.

2 nested properties
All object

Inspect all parts of the web request's JSON body.

IncludedPaths JsonPointerPath[]
MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Headers object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request headers.

3 nested properties
All object

Inspect all parts of the web request headers.

IncludedHeaders string[]
minItems=1maxItems=199
ExcludedHeaders string[]
minItems=1maxItems=199
MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request cookies.

3 nested properties
All object

Inspect all parts of the web request cookies.

IncludedCookies string[]
minItems=1maxItems=199
ExcludedCookies string[]
minItems=1maxItems=199
MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

MatchPattern object required

The pattern to look for in the JSON body.

2 nested properties
All object

Inspect all parts of the web request's JSON body.

IncludedPaths JsonPointerPath[]
MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

BodyParsingFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

JsonMatchScope string | Aws_CF_FunctionString

The parts of the JSON to match against using the MatchPattern.

JsonMatchPattern object

The pattern to look for in the JSON body.

All object

Inspect all parts of the web request's JSON body.

IncludedPaths JsonPointerPath[]
JsonPointerPath string | Aws_CF_FunctionString

JSON pointer path in the web request's JSON body

GeoMatchStatement object
CountryCodes string[]
ForwardedIPConfig object
2 nested properties
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
EntityId string | Aws_CF_FunctionString

Id of the WebACL

IPSetReferenceStatement object
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

IPSetForwardedIPConfig object
3 nested properties
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
Position string | Aws_CF_FunctionString required
ManagedRuleGroupStatement object
Name string | Aws_CF_FunctionString required

Name of the WebACL.

VendorName string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString
ExcludedRules ExcludedRule[]
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

15 nested properties
ByteMatchStatement object

Byte Match statement.

5 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
PositionalConstraint string | Aws_CF_FunctionString required

Position of the evaluation in the FieldToMatch of request.

SearchString string | Aws_CF_FunctionString

String that is searched to find a match.

SearchStringBase64 string | Aws_CF_FunctionString

Base64 encoded string that is searched to find a match.

SqliMatchStatement object

Sqli Match Statement.

3 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SensitivityLevel string | Aws_CF_FunctionString

Sensitivity Level current only used for sqli match statements.

XssMatchStatement object

Xss Match Statement.

2 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SizeConstraintStatement object

Size Constraint statement.

4 nested properties
FieldToMatch object required

Field of the request to match.

ComparisonOperator string | Aws_CF_FunctionString required
Size number required
min=0max=21474836480
TextTransformations TextTransformation[] required
GeoMatchStatement object
2 nested properties
CountryCodes string[]
ForwardedIPConfig object
RuleGroupReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

ExcludedRules ExcludedRule[]
RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
IPSetReferenceStatement object
2 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

IPSetForwardedIPConfig object
RegexPatternSetReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
ManagedRuleGroupStatement object
7 nested properties
Name string | Aws_CF_FunctionString required

Name of the WebACL.

VendorName string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString
ExcludedRules ExcludedRule[]
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ManagedRuleGroupConfigs ManagedRuleGroupConfig[]

Collection of ManagedRuleGroupConfig.

RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
RateBasedStatement object
4 nested properties
Limit integer required
min=100max=2000000000
AggregateKeyType string | Aws_CF_FunctionString required
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ForwardedIPConfig object
AndStatement object
1 nested properties
Statements Statement[] required
OrStatement object
1 nested properties
Statements Statement[] required
NotStatement object
1 nested properties
Statement object required

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

LabelMatchStatement object
2 nested properties
Scope string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RegexMatchStatement object
3 nested properties
RegexString string | Aws_CF_FunctionString required
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
ManagedRuleGroupConfigs ManagedRuleGroupConfig[]

Collection of ManagedRuleGroupConfig.

RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
NotStatement object
Statement object required

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

15 nested properties
ByteMatchStatement object

Byte Match statement.

5 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
PositionalConstraint string | Aws_CF_FunctionString required

Position of the evaluation in the FieldToMatch of request.

SearchString string | Aws_CF_FunctionString

String that is searched to find a match.

SearchStringBase64 string | Aws_CF_FunctionString

Base64 encoded string that is searched to find a match.

SqliMatchStatement object

Sqli Match Statement.

3 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SensitivityLevel string | Aws_CF_FunctionString

Sensitivity Level current only used for sqli match statements.

XssMatchStatement object

Xss Match Statement.

2 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SizeConstraintStatement object

Size Constraint statement.

4 nested properties
FieldToMatch object required

Field of the request to match.

ComparisonOperator string | Aws_CF_FunctionString required
Size number required
min=0max=21474836480
TextTransformations TextTransformation[] required
GeoMatchStatement object
2 nested properties
CountryCodes string[]
ForwardedIPConfig object
RuleGroupReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

ExcludedRules ExcludedRule[]
RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
IPSetReferenceStatement object
2 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

IPSetForwardedIPConfig object
RegexPatternSetReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
ManagedRuleGroupStatement object
7 nested properties
Name string | Aws_CF_FunctionString required

Name of the WebACL.

VendorName string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString
ExcludedRules ExcludedRule[]
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ManagedRuleGroupConfigs ManagedRuleGroupConfig[]

Collection of ManagedRuleGroupConfig.

RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
RateBasedStatement object
4 nested properties
Limit integer required
min=100max=2000000000
AggregateKeyType string | Aws_CF_FunctionString required
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ForwardedIPConfig object
AndStatement object
1 nested properties
Statements Statement[] required
OrStatement object
1 nested properties
Statements Statement[] required
NotStatement object
1 nested properties
Statement object required

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

LabelMatchStatement object
2 nested properties
Scope string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RegexMatchStatement object
3 nested properties
RegexString string | Aws_CF_FunctionString required
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
OrStatement object
Statements Statement[] required
OverrideAction object

Override a RuleGroup or ManagedRuleGroup behavior. This can only be applied to Rule that has RuleGroupReferenceStatement or ManagedRuleGroupReferenceStatement.

Count object

Count traffic towards application.

None object

Keep the RuleGroup or ManagedRuleGroup behavior as is.

PositionalConstraint string | Aws_CF_FunctionString

Position of the evaluation in the FieldToMatch of request.

QueryString object
RateBasedStatement object
Limit integer required
min=100max=2000000000
AggregateKeyType string | Aws_CF_FunctionString required
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

15 nested properties
ByteMatchStatement object

Byte Match statement.

5 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
PositionalConstraint string | Aws_CF_FunctionString required

Position of the evaluation in the FieldToMatch of request.

SearchString string | Aws_CF_FunctionString

String that is searched to find a match.

SearchStringBase64 string | Aws_CF_FunctionString

Base64 encoded string that is searched to find a match.

SqliMatchStatement object

Sqli Match Statement.

3 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SensitivityLevel string | Aws_CF_FunctionString

Sensitivity Level current only used for sqli match statements.

XssMatchStatement object

Xss Match Statement.

2 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SizeConstraintStatement object

Size Constraint statement.

4 nested properties
FieldToMatch object required

Field of the request to match.

ComparisonOperator string | Aws_CF_FunctionString required
Size number required
min=0max=21474836480
TextTransformations TextTransformation[] required
GeoMatchStatement object
2 nested properties
CountryCodes string[]
ForwardedIPConfig object
RuleGroupReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

ExcludedRules ExcludedRule[]
RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
IPSetReferenceStatement object
2 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

IPSetForwardedIPConfig object
RegexPatternSetReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
ManagedRuleGroupStatement object
7 nested properties
Name string | Aws_CF_FunctionString required

Name of the WebACL.

VendorName string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString
ExcludedRules ExcludedRule[]
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ManagedRuleGroupConfigs ManagedRuleGroupConfig[]

Collection of ManagedRuleGroupConfig.

RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
RateBasedStatement object
4 nested properties
Limit integer required
min=100max=2000000000
AggregateKeyType string | Aws_CF_FunctionString required
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ForwardedIPConfig object
AndStatement object
1 nested properties
Statements Statement[] required
OrStatement object
1 nested properties
Statements Statement[] required
NotStatement object
1 nested properties
Statement object required

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

LabelMatchStatement object
2 nested properties
Scope string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RegexMatchStatement object
3 nested properties
RegexString string | Aws_CF_FunctionString required
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
ForwardedIPConfig object
2 nested properties
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
RateLimit integer
RegexPatternSetReferenceStatement object
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
1 nested properties
Name string | Aws_CF_FunctionString required
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required
AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

1 nested properties
OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

4 nested properties
MatchPattern object required

The pattern to look for in the JSON body.

MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Headers object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request headers.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request cookies.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

TextTransformations TextTransformation[] required
ResourceArn string | Aws_CF_FunctionString

ARN of the WAF entity.

ForwardedIPConfiguration object
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
IPSetForwardedIPConfiguration object
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
Position string | Aws_CF_FunctionString required
Rule object

Rule of WebACL that contains condition and action.

Name string | Aws_CF_FunctionString required

Name of the WebACL.

Priority integer required

Priority of the Rule, Rules get evaluated from lower to higher priority.

min=0
Statement object required

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

15 nested properties
ByteMatchStatement object

Byte Match statement.

5 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
PositionalConstraint string | Aws_CF_FunctionString required

Position of the evaluation in the FieldToMatch of request.

SearchString string | Aws_CF_FunctionString

String that is searched to find a match.

SearchStringBase64 string | Aws_CF_FunctionString

Base64 encoded string that is searched to find a match.

SqliMatchStatement object

Sqli Match Statement.

3 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SensitivityLevel string | Aws_CF_FunctionString

Sensitivity Level current only used for sqli match statements.

XssMatchStatement object

Xss Match Statement.

2 nested properties
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
SizeConstraintStatement object

Size Constraint statement.

4 nested properties
FieldToMatch object required

Field of the request to match.

ComparisonOperator string | Aws_CF_FunctionString required
Size number required
min=0max=21474836480
TextTransformations TextTransformation[] required
GeoMatchStatement object
2 nested properties
CountryCodes string[]
ForwardedIPConfig object
RuleGroupReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

ExcludedRules ExcludedRule[]
RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
IPSetReferenceStatement object
2 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

IPSetForwardedIPConfig object
RegexPatternSetReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
ManagedRuleGroupStatement object
7 nested properties
Name string | Aws_CF_FunctionString required

Name of the WebACL.

VendorName string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString
ExcludedRules ExcludedRule[]
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ManagedRuleGroupConfigs ManagedRuleGroupConfig[]

Collection of ManagedRuleGroupConfig.

RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
RateBasedStatement object
4 nested properties
Limit integer required
min=100max=2000000000
AggregateKeyType string | Aws_CF_FunctionString required
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ForwardedIPConfig object
AndStatement object
1 nested properties
Statements Statement[] required
OrStatement object
1 nested properties
Statements Statement[] required
NotStatement object
1 nested properties
Statement object required

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

LabelMatchStatement object
2 nested properties
Scope string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RegexMatchStatement object
3 nested properties
RegexString string | Aws_CF_FunctionString required
FieldToMatch object required

Field of the request to match.

TextTransformations TextTransformation[] required
VisibilityConfig object required

Visibility Metric of the WebACL.

3 nested properties
SampledRequestsEnabled boolean required
CloudWatchMetricsEnabled boolean required
MetricName string | Aws_CF_FunctionString required
Action object

Action taken when Rule matches its condition.

5 nested properties
Allow object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

Block object

Block traffic towards application.

1 nested properties
CustomResponse object

Custom response.

Count object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

Captcha object

Checks valid token exists with request.

1 nested properties
CustomRequestHandling object

Custom request handling.

Challenge object

Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.

1 nested properties
CustomRequestHandling object

Custom request handling.

OverrideAction object

Override a RuleGroup or ManagedRuleGroup behavior. This can only be applied to Rule that has RuleGroupReferenceStatement or ManagedRuleGroupReferenceStatement.

2 nested properties
Count object

Count traffic towards application.

None object

Keep the RuleGroup or ManagedRuleGroup behavior as is.

RuleLabels Label[]

Collection of Rule Labels.

CaptchaConfig object
1 nested properties
ImmunityTimeProperty object
1 nested properties
ImmunityTime integer required
min=60max=259200
ChallengeConfig object
1 nested properties
ImmunityTimeProperty object
1 nested properties
ImmunityTime integer required
min=60max=259200
Rules Rule[]

Collection of Rules.

RuleAction object

Action taken when Rule matches its condition.

Allow object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
Block object

Block traffic towards application.

1 nested properties
CustomResponse object

Custom response.

3 nested properties
ResponseCode integer required

Custom response code.

min=200max=599
CustomResponseBodyKey string | Aws_CF_FunctionString

Custom response body key.

ResponseHeaders CustomHTTPHeader[]

Collection of HTTP headers.

minItems=1
Count object

Allow traffic towards application.

1 nested properties
CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
Captcha object

Checks valid token exists with request.

1 nested properties
CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
Challenge object

Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.

1 nested properties
CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
AllowAction object

Allow traffic towards application.

CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
CountAction object

Allow traffic towards application.

CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
CaptchaAction object

Checks valid token exists with request.

CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
ChallengeAction object

Checks that the request has a valid token with an unexpired challenge timestamp and, if not, returns a browser challenge to the client.

CustomRequestHandling object

Custom request handling.

1 nested properties
InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
BlockAction object

Block traffic towards application.

CustomResponse object

Custom response.

3 nested properties
ResponseCode integer required

Custom response code.

min=200max=599
CustomResponseBodyKey string | Aws_CF_FunctionString

Custom response body key.

ResponseHeaders CustomHTTPHeader[]

Collection of HTTP headers.

minItems=1
CustomHTTPHeaderName string | Aws_CF_FunctionString

HTTP header name.

CustomHTTPHeaderValue string | Aws_CF_FunctionString

HTTP header value.

CustomHTTPHeader object

HTTP header.

Name string | Aws_CF_FunctionString required

HTTP header name.

Value string | Aws_CF_FunctionString required

HTTP header value.

CustomRequestHandling object

Custom request handling.

InsertHeaders CustomHTTPHeader[] required

Collection of HTTP headers.

minItems=1
ResponseStatusCode integer

Custom response code.

ResponseContentType string | Aws_CF_FunctionString

Valid values are TEXT_PLAIN, TEXT_HTML, and APPLICATION_JSON.

ResponseContent string | Aws_CF_FunctionString

Response content.

CustomResponseBody object

Custom response body.

ContentType string | Aws_CF_FunctionString required

Valid values are TEXT_PLAIN, TEXT_HTML, and APPLICATION_JSON.

Content string | Aws_CF_FunctionString required

Response content.

CustomResponse object

Custom response.

ResponseCode integer required

Custom response code.

min=200max=599
CustomResponseBodyKey string | Aws_CF_FunctionString

Custom response body key.

ResponseHeaders CustomHTTPHeader[]

Collection of HTTP headers.

minItems=1
CustomResponseBodies object

Custom response key and body map.

RuleGroupReferenceStatement object
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

ExcludedRules ExcludedRule[]
RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
RulePriority integer

Priority of the Rule, Rules get evaluated from lower to higher priority.

Scope string | Aws_CF_FunctionString

Use CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.

SearchString string | Aws_CF_FunctionString

String that is searched to find a match.

SearchStringBase64 string | Aws_CF_FunctionString

Base64 encoded string that is searched to find a match.

SingleHeader object
Name string | Aws_CF_FunctionString
SingleQueryArgument object
Name string | Aws_CF_FunctionString
SizeConstraintStatement object

Size Constraint statement.

FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
1 nested properties
Name string | Aws_CF_FunctionString required
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required
AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

1 nested properties
OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

4 nested properties
MatchPattern object required

The pattern to look for in the JSON body.

MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Headers object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request headers.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request cookies.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

ComparisonOperator string | Aws_CF_FunctionString required
Size number required
min=0max=21474836480
TextTransformations TextTransformation[] required
SqliMatchStatement object

Sqli Match Statement.

FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
1 nested properties
Name string | Aws_CF_FunctionString required
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required
AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

1 nested properties
OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

4 nested properties
MatchPattern object required

The pattern to look for in the JSON body.

MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Headers object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request headers.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request cookies.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

TextTransformations TextTransformation[] required
SensitivityLevel string | Aws_CF_FunctionString

Sensitivity Level current only used for sqli match statements.

Statement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

ByteMatchStatement object

Byte Match statement.

5 nested properties
FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

Headers object

Includes headers of a web request.

Cookies object

Includes headers of a web request.

TextTransformations TextTransformation[] required
PositionalConstraint string | Aws_CF_FunctionString required

Position of the evaluation in the FieldToMatch of request.

SearchString string | Aws_CF_FunctionString

String that is searched to find a match.

SearchStringBase64 string | Aws_CF_FunctionString

Base64 encoded string that is searched to find a match.

SqliMatchStatement object

Sqli Match Statement.

3 nested properties
FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

Headers object

Includes headers of a web request.

Cookies object

Includes headers of a web request.

TextTransformations TextTransformation[] required
SensitivityLevel string | Aws_CF_FunctionString

Sensitivity Level current only used for sqli match statements.

XssMatchStatement object

Xss Match Statement.

2 nested properties
FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

Headers object

Includes headers of a web request.

Cookies object

Includes headers of a web request.

TextTransformations TextTransformation[] required
SizeConstraintStatement object

Size Constraint statement.

4 nested properties
FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

Headers object

Includes headers of a web request.

Cookies object

Includes headers of a web request.

ComparisonOperator string | Aws_CF_FunctionString required
Size number required
min=0max=21474836480
TextTransformations TextTransformation[] required
GeoMatchStatement object
2 nested properties
CountryCodes string[]
ForwardedIPConfig object
2 nested properties
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
RuleGroupReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

ExcludedRules ExcludedRule[]
RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
IPSetReferenceStatement object
2 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

IPSetForwardedIPConfig object
3 nested properties
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
Position string | Aws_CF_FunctionString required
RegexPatternSetReferenceStatement object
3 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the WAF entity.

FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

Headers object

Includes headers of a web request.

Cookies object

Includes headers of a web request.

TextTransformations TextTransformation[] required
ManagedRuleGroupStatement object
7 nested properties
Name string | Aws_CF_FunctionString required

Name of the WebACL.

VendorName string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString
ExcludedRules ExcludedRule[]
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

15 nested properties
ByteMatchStatement object

Byte Match statement.

SqliMatchStatement object

Sqli Match Statement.

XssMatchStatement object

Xss Match Statement.

SizeConstraintStatement object

Size Constraint statement.

GeoMatchStatement object
RuleGroupReferenceStatement object
IPSetReferenceStatement object
RegexPatternSetReferenceStatement object
ManagedRuleGroupStatement object
RateBasedStatement object
AndStatement object
OrStatement object
NotStatement object
LabelMatchStatement object
RegexMatchStatement object
ManagedRuleGroupConfigs ManagedRuleGroupConfig[]

Collection of ManagedRuleGroupConfig.

RuleActionOverrides RuleActionOverride[]

Action overrides for rules in the rule group.

minItems=1maxItems=100
RateBasedStatement object
4 nested properties
Limit integer required
min=100max=2000000000
AggregateKeyType string | Aws_CF_FunctionString required
ScopeDownStatement object

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

15 nested properties
ByteMatchStatement object

Byte Match statement.

SqliMatchStatement object

Sqli Match Statement.

XssMatchStatement object

Xss Match Statement.

SizeConstraintStatement object

Size Constraint statement.

GeoMatchStatement object
RuleGroupReferenceStatement object
IPSetReferenceStatement object
RegexPatternSetReferenceStatement object
ManagedRuleGroupStatement object
RateBasedStatement object
AndStatement object
OrStatement object
NotStatement object
LabelMatchStatement object
RegexMatchStatement object
ForwardedIPConfig object
2 nested properties
HeaderName string | Aws_CF_FunctionString required
FallbackBehavior string | Aws_CF_FunctionString required
AndStatement object
1 nested properties
Statements Statement[] required
OrStatement object
1 nested properties
Statements Statement[] required
NotStatement object
1 nested properties
Statement object required

First level statement that contains conditions, such as ByteMatch, SizeConstraint, etc

15 nested properties
ByteMatchStatement object

Byte Match statement.

SqliMatchStatement object

Sqli Match Statement.

XssMatchStatement object

Xss Match Statement.

SizeConstraintStatement object

Size Constraint statement.

GeoMatchStatement object
RuleGroupReferenceStatement object
IPSetReferenceStatement object
RegexPatternSetReferenceStatement object
ManagedRuleGroupStatement object
RateBasedStatement object
AndStatement object
OrStatement object
NotStatement object
LabelMatchStatement object
RegexMatchStatement object
LabelMatchStatement object
2 nested properties
Scope string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RegexMatchStatement object
3 nested properties
RegexString string | Aws_CF_FunctionString required
FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

Headers object

Includes headers of a web request.

Cookies object

Includes headers of a web request.

TextTransformations TextTransformation[] required
Tag object
Key string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString
TextTransformation object

Text Transformation on the Search String before match.

Priority integer required

Priority of Rule being evaluated.

min=0
Type string | Aws_CF_FunctionString required

Type of text transformation.

TextTransformationPriority integer

Priority of Rule being evaluated.

TextTransformationType string | Aws_CF_FunctionString

Type of text transformation.

UriPath object
VisibilityConfig object

Visibility Metric of the WebACL.

SampledRequestsEnabled boolean required
CloudWatchMetricsEnabled boolean required
MetricName string | Aws_CF_FunctionString required
XssMatchStatement object

Xss Match Statement.

FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
1 nested properties
Name string | Aws_CF_FunctionString required
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required
AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

1 nested properties
OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

4 nested properties
MatchPattern object required

The pattern to look for in the JSON body.

MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Headers object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request headers.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request cookies.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

TextTransformations TextTransformation[] required
LabelName string | Aws_CF_FunctionString

Name of the Label.

Label object
Name string | Aws_CF_FunctionString required

Name of the Label.

LabelMatchKey string | Aws_CF_FunctionString
LabelMatchScope string | Aws_CF_FunctionString
LabelMatchStatement object
Scope string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RegexMatchStatement object
RegexString string | Aws_CF_FunctionString required
FieldToMatch object required

Field of the request to match.

10 nested properties
SingleHeader object
1 nested properties
Name string | Aws_CF_FunctionString required
SingleQueryArgument object

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required
AllQueryArguments object

All query arguments of a web request.

UriPath object

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

QueryString object

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

Body object

The body of a web request. This immediately follows the request headers.

1 nested properties
OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Method object

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers.

4 nested properties
MatchPattern object required

The pattern to look for in the JSON body.

MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern.

InvalidFallbackBehavior string | Aws_CF_FunctionString

The inspection behavior to fall back to if the JSON in the request body is invalid.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

Headers object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request headers.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

3 nested properties
MatchPattern object required

The pattern to look for in the request cookies.

MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

TextTransformations TextTransformation[] required
CaptchaConfig object
ImmunityTimeProperty object
1 nested properties
ImmunityTime integer required
min=60max=259200
ChallengeConfig object
ImmunityTimeProperty object
1 nested properties
ImmunityTime integer required
min=60max=259200
ImmunityTimeProperty object
ImmunityTime integer required
min=60max=259200
ManagedRuleGroupConfig object

ManagedRuleGroupConfig.

LoginPath string | Aws_CF_FunctionString
PayloadType string | Aws_CF_FunctionString
UsernameField object
1 nested properties
Identifier string | Aws_CF_FunctionString required
PasswordField object
1 nested properties
Identifier string | Aws_CF_FunctionString required
AWSManagedRulesBotControlRuleSet object

Configures how to use the Bot Control managed rule group in the web ACL

1 nested properties
InspectionLevel string | Aws_CF_FunctionString required
AWSManagedRulesATPRuleSet object

Configures how to use the Account Takeover Prevention managed rule group in the web ACL

3 nested properties
LoginPath string | Aws_CF_FunctionString required
RequestInspection object

Configures the inspection of login requests

3 nested properties
PayloadType string | Aws_CF_FunctionString required
UsernameField object required
PasswordField object required
ResponseInspection object

Configures the inspection of login responses

4 nested properties
StatusCode object

Response status codes that indicate success or failure of a login request

Header object

Response headers that indicate success or failure of a login request

BodyContains object

Response body contents that indicate success or failure of a login request

Json object

Response JSON that indicate success or failure of a login request

AWSManagedRulesBotControlRuleSet object

Configures how to use the Bot Control managed rule group in the web ACL

InspectionLevel string | Aws_CF_FunctionString required
AWSManagedRulesATPRuleSet object

Configures how to use the Account Takeover Prevention managed rule group in the web ACL

LoginPath string | Aws_CF_FunctionString required
RequestInspection object

Configures the inspection of login requests

3 nested properties
PayloadType string | Aws_CF_FunctionString required
UsernameField object required
1 nested properties
Identifier string | Aws_CF_FunctionString required
PasswordField object required
1 nested properties
Identifier string | Aws_CF_FunctionString required
ResponseInspection object

Configures the inspection of login responses

4 nested properties
StatusCode object

Response status codes that indicate success or failure of a login request

2 nested properties
SuccessCodes integer[] required
minItems=1maxItems=10
FailureCodes integer[] required
minItems=1maxItems=10
Header object

Response headers that indicate success or failure of a login request

3 nested properties
Name string | Aws_CF_FunctionString required
SuccessValues string[] required
minItems=1maxItems=3
FailureValues string[] required
minItems=1maxItems=3
BodyContains object

Response body contents that indicate success or failure of a login request

2 nested properties
SuccessStrings string[] required
minItems=1maxItems=5
FailureStrings string[] required
minItems=1maxItems=5
Json object

Response JSON that indicate success or failure of a login request

3 nested properties
Identifier string | Aws_CF_FunctionString required
SuccessValues string[] required
minItems=1maxItems=5
FailureValues string[] required
minItems=1maxItems=5
RequestInspection object

Configures the inspection of login requests

PayloadType string | Aws_CF_FunctionString required
UsernameField object required
1 nested properties
Identifier string | Aws_CF_FunctionString required
PasswordField object required
1 nested properties
Identifier string | Aws_CF_FunctionString required
ResponseInspection object

Configures the inspection of login responses

StatusCode object

Response status codes that indicate success or failure of a login request

2 nested properties
SuccessCodes integer[] required
minItems=1maxItems=10
FailureCodes integer[] required
minItems=1maxItems=10
Header object

Response headers that indicate success or failure of a login request

3 nested properties
Name string | Aws_CF_FunctionString required
SuccessValues string[] required
minItems=1maxItems=3
FailureValues string[] required
minItems=1maxItems=3
BodyContains object

Response body contents that indicate success or failure of a login request

2 nested properties
SuccessStrings string[] required
minItems=1maxItems=5
FailureStrings string[] required
minItems=1maxItems=5
Json object

Response JSON that indicate success or failure of a login request

3 nested properties
Identifier string | Aws_CF_FunctionString required
SuccessValues string[] required
minItems=1maxItems=5
FailureValues string[] required
minItems=1maxItems=5
ResponseInspectionStatusCode object

Response status codes that indicate success or failure of a login request

SuccessCodes integer[] required
minItems=1maxItems=10
FailureCodes integer[] required
minItems=1maxItems=10
ResponseInspectionHeader object

Response headers that indicate success or failure of a login request

Name string | Aws_CF_FunctionString required
SuccessValues string[] required
minItems=1maxItems=3
FailureValues string[] required
minItems=1maxItems=3
ResponseInspectionBodyContains object

Response body contents that indicate success or failure of a login request

SuccessStrings string[] required
minItems=1maxItems=5
FailureStrings string[] required
minItems=1maxItems=5
ResponseInspectionJson object

Response JSON that indicate success or failure of a login request

Identifier string | Aws_CF_FunctionString required
SuccessValues string[] required
minItems=1maxItems=5
FailureValues string[] required
minItems=1maxItems=5
TokenDomains string[]

List of domains to accept in web request tokens, in addition to the domain of the protected resource.

FieldIdentifier object
Identifier string | Aws_CF_FunctionString required
Headers object

Includes headers of a web request.

MatchPattern object required

The pattern to look for in the request headers.

3 nested properties
All object

Inspect all parts of the web request headers.

IncludedHeaders string[]
minItems=1maxItems=199
ExcludedHeaders string[]
minItems=1maxItems=199
MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

Cookies object

Includes headers of a web request.

MatchPattern object required

The pattern to look for in the request cookies.

3 nested properties
All object

Inspect all parts of the web request cookies.

IncludedCookies string[]
minItems=1maxItems=199
ExcludedCookies string[]
minItems=1maxItems=199
MatchScope string | Aws_CF_FunctionString required

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString required

Handling of requests containing oversize fields

HeaderMatchPattern object

The pattern to look for in the request headers.

All object

Inspect all parts of the web request headers.

IncludedHeaders string[]
minItems=1maxItems=199
ExcludedHeaders string[]
minItems=1maxItems=199
CookieMatchPattern object

The pattern to look for in the request cookies.

All object

Inspect all parts of the web request cookies.

IncludedCookies string[]
minItems=1maxItems=199
ExcludedCookies string[]
minItems=1maxItems=199
MapMatchScope string | Aws_CF_FunctionString

The parts of the request to match against using the MatchPattern.

OversizeHandling string | Aws_CF_FunctionString

Handling of requests containing oversize fields

SensitivityLevel string | Aws_CF_FunctionString

Sensitivity Level current only used for sqli match statements.