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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getJsonBody

@Stability(Stable)
@Nullable
default Object getJsonBody()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-jsonbody

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-method

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-querystring

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" }

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-singleheader

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html#cfn-wafv2-loggingconfiguration-fieldtomatch-uripath

builder

@Stability(Stable)
static CfnLoggingConfiguration.FieldToMatchProperty.Builder builder()

Returns:

a CfnLoggingConfiguration.FieldToMatchProperty.Builder of CfnLoggingConfiguration.FieldToMatchProperty