AWS::WAFv2::LoggingConfiguration FieldToMatch - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::WAFv2::LoggingConfiguration FieldToMatch

The parts of the request that you want to keep out of the logs. This is used in the logging configuration RedactedFields specification.

Example JSON for a QueryString field to match:

"FieldToMatch": { "QueryString": {} }

Example JSON for a Method field to match specification:

"FieldToMatch": { "Method": { "Name": "DELETE" } }

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Method" : Json,
  "QueryString" : Json,
  "SingleHeader" : SingleHeader,
  "UriPath" : Json
}

Properties

Method

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

Required: No

Type: Json

Update requires: No interruption

QueryString

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

Required: No

Type: Json

Update requires: No interruption

SingleHeader

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

Example JSON: "SingleHeader": { "Name": "haystack" }

Required: No

Type: SingleHeader

Update requires: No interruption

UriPath

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

Required: No

Type: Json

Update requires: No interruption