software.amazon.awscdk.services.wafv2

Interface CfnLoggingConfiguration.FieldToMatchProperty

All Known Implementing Classes:

CfnLoggingConfiguration.FieldToMatchProperty.Jsii$Proxy

Enclosing class:

CfnLoggingConfiguration

public static interface CfnLoggingConfiguration.FieldToMatchProperty

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLoggingConfiguration.FieldToMatchProperty.Builder A builder for CfnLoggingConfiguration.FieldToMatchProperty
static class	CfnLoggingConfiguration.FieldToMatchProperty.Jsii$Proxy An implementation for CfnLoggingConfiguration.FieldToMatchProperty

Method Summary

Modifier and Type	Method and Description
static CfnLoggingConfiguration.FieldToMatchProperty.Builder	builder()
default java.lang.Object	getJsonBody() Redact the request body JSON.
default java.lang.Object	getMethod() Redact the indicated HTTP method.
default java.lang.Object	getQueryString() Redact the query string.
default java.lang.Object	getSingleHeader() Redact a single header.
default java.lang.Object	getUriPath() Redact the request URI path.

Method Detail

getJsonBody

default java.lang.Object getJsonBody()

Redact the request body JSON.

getMethod

default java.lang.Object getMethod()

Redact the indicated HTTP method.

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

getQueryString

default java.lang.Object getQueryString()

Redact the query string.

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

getSingleHeader

default java.lang.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

default java.lang.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

static CfnLoggingConfiguration.FieldToMatchProperty.Builder builder()

Returns:

a CfnLoggingConfiguration.FieldToMatchProperty.Builder of CfnLoggingConfiguration.FieldToMatchProperty