Package software.amazon.awscdk.services.wafv2

Interface CfnLoggingConfiguration.FieldToMatchProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnLoggingConfiguration.FieldToMatchProperty.Jsii$Proxy
Enclosing class:
CfnLoggingConfiguration
@Stability(Stable) public static interface CfnLoggingConfiguration.FieldToMatchProperty extends software.amazon.jsii.JsiiSerializable
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" } }

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 Object jsonBody;
 Object method;
 Object queryString;
 Object singleHeader;
 Object uriPath;
 FieldToMatchProperty fieldToMatchProperty = FieldToMatchProperty.builder()
         .jsonBody(jsonBody)
         .method(method)
         .queryString(queryString)
         .singleHeader(singleHeader)
         .uriPath(uriPath)
         .build();

  • Method Details

    • getJsonBody

      @Stability(Stable) @Nullable default Object getJsonBody()
      Redact the request body JSON.

    • getMethod

      @Stability(Stable) @Nullable default Object getMethod()
      Redact the indicated HTTP method.

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

    • getQueryString

      @Stability(Stable) @Nullable default Object getQueryString()
      Redact the query string.

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

    • getSingleHeader

      @Stability(Stable) @Nullable default Object getSingleHeader()
      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" }

    • getUriPath

      @Stability(Stable) @Nullable default Object getUriPath()
      Redact the request URI path.

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

    • builder

      @Stability(Stable) static CfnLoggingConfiguration.FieldToMatchProperty.Builder builder()
      Returns:
      a CfnLoggingConfiguration.FieldToMatchProperty.Builder of CfnLoggingConfiguration.FieldToMatchProperty