software.amazon.awssdk.services.wafv2.model

Interface LoggingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LoggingConfiguration.Builder,LoggingConfiguration>, SdkBuilder<LoggingConfiguration.Builder,LoggingConfiguration>, SdkPojo

Enclosing class:

LoggingConfiguration

public static interface LoggingConfiguration.Builder
extends SdkPojo, CopyableBuilder<LoggingConfiguration.Builder,LoggingConfiguration>

Method Summary

Modifier and Type	Method and Description
LoggingConfiguration.Builder	logDestinationConfigs(Collection<String> logDestinationConfigs) The logging destination configuration that you want to associate with the web ACL.
LoggingConfiguration.Builder	logDestinationConfigs(String... logDestinationConfigs) The logging destination configuration that you want to associate with the web ACL.
default LoggingConfiguration.Builder	loggingFilter(Consumer<LoggingFilter.Builder> loggingFilter) Filtering that specifies which web requests are kept in the logs and which are dropped.
LoggingConfiguration.Builder	loggingFilter(LoggingFilter loggingFilter) Filtering that specifies which web requests are kept in the logs and which are dropped.
LoggingConfiguration.Builder	managedByFirewallManager(Boolean managedByFirewallManager) Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration.
LoggingConfiguration.Builder	redactedFields(Collection<FieldToMatch> redactedFields) The parts of the request that you want to keep out of the logs.
LoggingConfiguration.Builder	redactedFields(Consumer<FieldToMatch.Builder>... redactedFields) The parts of the request that you want to keep out of the logs.
LoggingConfiguration.Builder	redactedFields(FieldToMatch... redactedFields) The parts of the request that you want to keep out of the logs.
LoggingConfiguration.Builder	resourceArn(String resourceArn) The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

resourceArn

LoggingConfiguration.Builder resourceArn(String resourceArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

logDestinationConfigs

LoggingConfiguration.Builder logDestinationConfigs(Collection<String> logDestinationConfigs)

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

You can associate one logging destination to a web ACL.

Parameters:

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

You can associate one logging destination to a web ACL.

Returns:

Returns a reference to this object so that method calls can be chained together.

logDestinationConfigs

LoggingConfiguration.Builder logDestinationConfigs(String... logDestinationConfigs)

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

You can associate one logging destination to a web ACL.

Parameters:

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

You can associate one logging destination to a web ACL.

Returns:

Returns a reference to this object so that method calls can be chained together.

redactedFields

LoggingConfiguration.Builder redactedFields(Collection<FieldToMatch> redactedFields)

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.

Parameters:

redactedFields - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

redactedFields

LoggingConfiguration.Builder redactedFields(FieldToMatch... redactedFields)

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.

Parameters:

redactedFields - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

redactedFields

LoggingConfiguration.Builder redactedFields(Consumer<FieldToMatch.Builder>... redactedFields)

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 is a convenience method that creates an instance of the FieldToMatch.Builder avoiding the need to create one manually via FieldToMatch.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #redactedFields(List).

Parameters:

redactedFields - a consumer that will call methods on FieldToMatch.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#redactedFields(java.util.Collection)

managedByFirewallManager

LoggingConfiguration.Builder managedByFirewallManager(Boolean managedByFirewallManager)

Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

Parameters:

managedByFirewallManager - Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

loggingFilter

LoggingConfiguration.Builder loggingFilter(LoggingFilter loggingFilter)

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.

Parameters:

loggingFilter - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

loggingFilter

default LoggingConfiguration.Builder loggingFilter(Consumer<LoggingFilter.Builder> loggingFilter)

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.

This is a convenience method that creates an instance of the LoggingFilter.Builder avoiding the need to create one manually via LoggingFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingFilter(LoggingFilter).

Parameters:

loggingFilter - a consumer that will call methods on LoggingFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

loggingFilter(LoggingFilter)