software.amazon.awscdk.services.wafv2

Interface CfnLoggingConfigurationProps

All Known Implementing Classes:

CfnLoggingConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:26.050Z")
public interface CfnLoggingConfigurationProps

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getLogDestinationConfigs

java.util.List<java.lang.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.

getResourceArn

java.lang.String getResourceArn()

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

getLoggingFilter

default java.lang.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.

getRedactedFields

default java.lang.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 .

You can specify only the following fields for redaction: UriPath , QueryString , SingleHeader , Method , and JsonBody .

builder

static CfnLoggingConfigurationProps.Builder builder()

Returns:

a CfnLoggingConfigurationProps.Builder of CfnLoggingConfigurationProps