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

A WAFv2 Logging Configuration Resource Provider. Source:- https://github.com/advaj/aws-cloudformation-resource-providers-wafv2.git

Properties

ResourceArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

LogDestinationConfigs string[] required

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.

RedactedFields FieldToMatch[]

The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

LoggingFilter object

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

2 nested properties
DefaultBehavior string | Aws_CF_FunctionString required

Default handling for logs that don't match any of the specified filtering conditions.

Filters Filter[] required

The filters that you want to apply to the logs.

minItems=1

Definitions

Filter object
Behavior string | Aws_CF_FunctionString required

How to handle logs that satisfy the filter's conditions and requirement.

Conditions Condition[] required

Match conditions for the filter.

minItems=1
Requirement string | Aws_CF_FunctionString required

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

Condition object
ActionCondition object

A single action condition.

1 nested properties
Action string | Aws_CF_FunctionString required

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

LabelNameCondition object

A single label name condition.

1 nested properties
LabelName string | Aws_CF_FunctionString required

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

FieldToMatch object

A key-value pair to associate with a resource.

JsonBody object

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

3 nested properties
MatchPattern object required

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

2 nested properties
All object

Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.

IncludedPaths string[]

Match only the specified include paths. See also MatchScope in JsonBody.

minItems=1
MatchScope string | Aws_CF_FunctionString required

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

InvalidFallbackBehavior string | Aws_CF_FunctionString

What AWS WAF should do if it fails to completely parse the JSON body.

Method object

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

QueryString object

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

SingleHeader object

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

1 nested properties
Name string | Aws_CF_FunctionString required

The name of the query header to inspect.

UriPath object

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