Class CfnLoggingConfiguration.FieldToMatchProperty
The parts of the request that you want to keep out of the logs.
Inheritance
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FieldToMatchProperty : Object, CfnLoggingConfiguration.IFieldToMatchProperty
Syntax (vb)
Public Class FieldToMatchProperty
Inherits Object
Implements CfnLoggingConfiguration.IFieldToMatchProperty
Remarks
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" } }
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;
var jsonBody;
var method;
var queryString;
var singleHeader;
var uriPath;
var fieldToMatchProperty = new FieldToMatchProperty {
JsonBody = jsonBody,
Method = method,
QueryString = queryString,
SingleHeader = singleHeader,
UriPath = uriPath
};
Synopsis
Constructors
FieldToMatchProperty() |
Properties
JsonBody | |
Method | Redact the indicated HTTP method. |
QueryString | Redact the query string. |
SingleHeader | Redact a single header. |
UriPath | Redact the request URI path. |
Constructors
FieldToMatchProperty()
public FieldToMatchProperty()
Properties
JsonBody
public object JsonBody { get; set; }
Property Value
System.Object
Remarks
Method
Redact the indicated HTTP method.
public object Method { get; set; }
Property Value
System.Object
Remarks
The method indicates the type of operation that the request is asking the origin to perform.
QueryString
Redact the query string.
public object QueryString { get; set; }
Property Value
System.Object
Remarks
This is the part of a URL that appears after a ?
character, if any.
SingleHeader
Redact a single header.
public object SingleHeader { get; set; }
Property Value
System.Object
Remarks
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" }
UriPath
Redact the request URI path.
public object UriPath { get; set; }
Property Value
System.Object
Remarks
This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg
.