Class CfnLoggingConfiguration.FieldToMatchProperty

The parts of the request that you want to keep out of the logs.

Inheritance

object

CfnLoggingConfiguration.FieldToMatchProperty

Implements

CfnLoggingConfiguration.IFieldToMatchProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLoggingConfiguration.FieldToMatchProperty : CfnLoggingConfiguration.IFieldToMatchProperty

Syntax (vb)

Public Class CfnLoggingConfiguration.FieldToMatchProperty 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" } }

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

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

The parts of the request that you want to keep out of the logs.

Properties

JsonBody	The parts of the request that you want to keep out of the logs.
Method	Redact the indicated HTTP method.
QueryString	Redact the query string.
SingleHeader	Redact a single header.
UriPath	Redact the request URI path.

Constructors

FieldToMatchProperty()

The parts of the request that you want to keep out of the logs.

public FieldToMatchProperty()

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

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

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

Properties

JsonBody

The parts of the request that you want to keep out of the logs.

public object? JsonBody { get; set; }

Property Value

object

Remarks

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

Method

Redact the indicated HTTP method.

public object? Method { get; set; }

Property Value

object

Remarks

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

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

QueryString

Redact the query string.

public object? QueryString { get; set; }

Property Value

object

Remarks

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

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

SingleHeader

Redact a single header.

public object? SingleHeader { get; set; }

Property Value

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

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

UriPath

Redact the request URI path.

public object? UriPath { get; set; }

Property Value

object

Remarks

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

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

Implements

CfnLoggingConfiguration.IFieldToMatchProperty