Package software.amazon.awscdk.mixins.preview.services.wafv2.mixins

Class CfnLoggingConfigurationPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.wafv2.mixins.CfnLoggingConfigurationPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLoggingConfigurationPropsMixin>

Enclosing class:

CfnLoggingConfigurationPropsMixin

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

A fluent builder for CfnLoggingConfigurationPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnLoggingConfigurationPropsMixin	build()
static CfnLoggingConfigurationPropsMixin.Builder	create()
static CfnLoggingConfigurationPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnLoggingConfigurationPropsMixin.Builder	logDestinationConfigs(List<String> logDestinationConfigs)	The logging destination configuration that you want to associate with the web ACL.
CfnLoggingConfigurationPropsMixin.Builder	loggingFilter(Object loggingFilter)	Filtering that specifies which web requests are kept in the logs and which are dropped.
CfnLoggingConfigurationPropsMixin.Builder	redactedFields(List<? extends Object> redactedFields)	The parts of the request that you want to keep out of the logs.
CfnLoggingConfigurationPropsMixin.Builder	redactedFields(IResolvable redactedFields)	The parts of the request that you want to keep out of the logs.
CfnLoggingConfigurationPropsMixin.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 CfnLoggingConfigurationPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLoggingConfigurationPropsMixin.Builder.

create

@Stability(Stable)
public static CfnLoggingConfigurationPropsMixin.Builder create()

Returns:

a new instance of CfnLoggingConfigurationPropsMixin.Builder.

logDestinationConfigs

@Stability(Stable)
public CfnLoggingConfigurationPropsMixin.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

loggingFilter

@Stability(Stable)
public CfnLoggingConfigurationPropsMixin.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 CfnLoggingConfigurationPropsMixin.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.

If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs.

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. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.

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

If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs.

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. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.

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

resourceArn

@Stability(Stable)
public CfnLoggingConfigurationPropsMixin.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

build

@Stability(Stable)
public CfnLoggingConfigurationPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnLoggingConfigurationPropsMixin.