Package software.amazon.awscdk.services.wafv2

Class CfnLoggingConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.wafv2.CfnLoggingConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLoggingConfiguration>

Enclosing class:

CfnLoggingConfiguration

@Stability(Stable)
public static final class CfnLoggingConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLoggingConfiguration>

A fluent builder for CfnLoggingConfiguration.

Method Summary

Modifier and Type	Method	Description
CfnLoggingConfiguration	build()
static CfnLoggingConfiguration.Builder	create(software.constructs.Construct scope, String id)
CfnLoggingConfiguration.Builder	logDestinationConfigs(List<String> logDestinationConfigs)	The logging destination configuration that you want to associate with the web ACL.
CfnLoggingConfiguration.Builder	loggingFilter(Object loggingFilter)	Filtering that specifies which web requests are kept in the logs and which are dropped.
CfnLoggingConfiguration.Builder	redactedFields(List<? extends Object> redactedFields)	The parts of the request that you want to keep out of the logs.
CfnLoggingConfiguration.Builder	redactedFields(IResolvable redactedFields)	The parts of the request that you want to keep out of the logs.
CfnLoggingConfiguration.Builder	resourceArn(String resourceArn)	The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLoggingConfiguration.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLoggingConfiguration.Builder.

logDestinationConfigs

@Stability(Stable)
public CfnLoggingConfiguration.Builder logDestinationConfigs(List<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. This parameter is required.

Returns:

this

See Also:

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

resourceArn

@Stability(Stable)
public CfnLoggingConfiguration.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 . This parameter is required.

Returns:

this

See Also:

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

loggingFilter

@Stability(Stable)
public CfnLoggingConfiguration.Builder loggingFilter(Object 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. This parameter is required.

Returns:

this

See Also:

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

redactedFields

@Stability(Stable)
public CfnLoggingConfiguration.Builder redactedFields(IResolvable 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 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.

Parameters:

redactedFields - The parts of the request that you want to keep out of the logs. This parameter is required.

Returns:

this

See Also:

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

redactedFields

@Stability(Stable)
public CfnLoggingConfiguration.Builder redactedFields(List<? extends Object> 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 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.

Parameters:

redactedFields - The parts of the request that you want to keep out of the logs. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLoggingConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLoggingConfiguration>

Returns:

a newly built instance of CfnLoggingConfiguration.