Package software.amazon.awscdk.services.wafv2

Interface CfnLoggingConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLoggingConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:19.056Z")
@Stability(Stable)
public interface CfnLoggingConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLoggingConfiguration.

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 loggingFilter;
 Object method;
 Object queryString;
 Object singleHeader;
 Object uriPath;
 CfnLoggingConfigurationProps cfnLoggingConfigurationProps = CfnLoggingConfigurationProps.builder()
         .logDestinationConfigs(List.of("logDestinationConfigs"))
         .resourceArn("resourceArn")
         // the properties below are optional
         .loggingFilter(loggingFilter)
         .redactedFields(List.of(FieldToMatchProperty.builder()
                 .jsonBody(jsonBody)
                 .method(method)
                 .queryString(queryString)
                 .singleHeader(singleHeader)
                 .uriPath(uriPath)
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLoggingConfigurationProps.Builder	builder()
List<String>	getLogDestinationConfigs()	The logging destination configuration that you want to associate with the web ACL.
default Object	getLoggingFilter()	Filtering that specifies which web requests are kept in the logs and which are dropped.
default Object	getRedactedFields()	The parts of the request that you want to keep out of the logs.
String	getResourceArn()	The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogDestinationConfigs

@Stability(Stable)
@NotNull
List<String> getLogDestinationConfigs()

The logging destination configuration that you want to associate with the web ACL.

You can associate one logging destination to a web ACL.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-logdestinationconfigs

getResourceArn

@Stability(Stable)
@NotNull
String getResourceArn()

The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-resourcearn

getLoggingFilter

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

Filtering that specifies which web requests are kept in the logs and which are dropped.

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-loggingfilter

getRedactedFields

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

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

For example, if you redact the SingleHeader field, the HEADER field in the logs will be REDACTED for all rules that use the SingleHeader FieldToMatch setting.

Redaction applies only to the component that's specified in the rule's FieldToMatch setting, so the SingleHeader redaction doesn't apply to rules that use the Headers FieldToMatch .

You can specify only the following fields for redaction: UriPath , QueryString , SingleHeader , and Method . > This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-redactedfields

builder

@Stability(Stable)
static CfnLoggingConfigurationProps.Builder builder()

Returns:

a CfnLoggingConfigurationProps.Builder of CfnLoggingConfigurationProps