Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Interface CfnLoggingConfigurationPropsMixin.FieldToMatchProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLoggingConfigurationPropsMixin.FieldToMatchProperty.Jsii$Proxy

Enclosing class:

CfnLoggingConfigurationPropsMixin

@Stability(Stable)
public static interface CfnLoggingConfigurationPropsMixin.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.cfnpropertymixins.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	CfnLoggingConfigurationPropsMixin.FieldToMatchProperty.Builder	A builder for CfnLoggingConfigurationPropsMixin.FieldToMatchProperty
static final class	CfnLoggingConfigurationPropsMixin.FieldToMatchProperty.Jsii$Proxy	An implementation for CfnLoggingConfigurationPropsMixin.FieldToMatchProperty

Method Summary

Modifier and Type	Method	Description
static CfnLoggingConfigurationPropsMixin.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 CfnLoggingConfigurationPropsMixin.FieldToMatchProperty.Builder builder()

Returns:

a CfnLoggingConfigurationPropsMixin.FieldToMatchProperty.Builder of CfnLoggingConfigurationPropsMixin.FieldToMatchProperty