Package software.amazon.awscdk.services.observabilityadmin

Interface CfnTelemetryRule.FieldToMatchProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTelemetryRule.FieldToMatchProperty.Jsii$Proxy

Enclosing class:

CfnTelemetryRule

@Stability(Stable)
public static interface CfnTelemetryRule.FieldToMatchProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a field in the request to redact from WAF logs, such as headers, query parameters, or body content.

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.observabilityadmin.*;
 FieldToMatchProperty fieldToMatchProperty = FieldToMatchProperty.builder()
         .method("method")
         .queryString("queryString")
         .singleHeader(SingleHeaderProperty.builder()
                 .name("name")
                 .build())
         .uriPath("uriPath")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTelemetryRule.FieldToMatchProperty.Builder	builder()
default String	getMethod()	Redacts the HTTP method from WAF logs.
default String	getQueryString()	Redacts the entire query string from WAF logs.
default Object	getSingleHeader()	Redacts a specific header field by name from WAF logs.
default String	getUriPath()	Redacts the URI path from WAF logs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMethod

@Stability(Stable)
@Nullable
default String getMethod()

Redacts the HTTP method from WAF logs.

See Also:

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

getQueryString

@Stability(Stable)
@Nullable
default String getQueryString()

Redacts the entire query string from WAF logs.

See Also:

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

getSingleHeader

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

Redacts a specific header field by name from WAF logs.

Returns union: either IResolvable or CfnTelemetryRule.SingleHeaderProperty

See Also:

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

getUriPath

@Stability(Stable)
@Nullable
default String getUriPath()

Redacts the URI path from WAF logs.

See Also:

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

builder

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

Returns:

a CfnTelemetryRule.FieldToMatchProperty.Builder of CfnTelemetryRule.FieldToMatchProperty