Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Class CfnWebACLPropsMixin.VisibilityConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnWebACLPropsMixin.VisibilityConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWebACLPropsMixin.VisibilityConfigProperty>

Enclosing interface:

CfnWebACLPropsMixin.VisibilityConfigProperty

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

A builder for CfnWebACLPropsMixin.VisibilityConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWebACLPropsMixin.VisibilityConfigProperty	build()	Builds the configured instance.
CfnWebACLPropsMixin.VisibilityConfigProperty.Builder	cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)	Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getCloudWatchMetricsEnabled()
CfnWebACLPropsMixin.VisibilityConfigProperty.Builder	cloudWatchMetricsEnabled(IResolvable cloudWatchMetricsEnabled)	Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getCloudWatchMetricsEnabled()
CfnWebACLPropsMixin.VisibilityConfigProperty.Builder	metricName(String metricName)	Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getMetricName()
CfnWebACLPropsMixin.VisibilityConfigProperty.Builder	sampledRequestsEnabled(Boolean sampledRequestsEnabled)	Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getSampledRequestsEnabled()
CfnWebACLPropsMixin.VisibilityConfigProperty.Builder	sampledRequestsEnabled(IResolvable sampledRequestsEnabled)	Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getSampledRequestsEnabled()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cloudWatchMetricsEnabled

@Stability(Stable)
public CfnWebACLPropsMixin.VisibilityConfigProperty.Builder cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)

Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getCloudWatchMetricsEnabled()

Parameters:

cloudWatchMetricsEnabled - Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .

For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .

Returns:

this

cloudWatchMetricsEnabled

@Stability(Stable)
public CfnWebACLPropsMixin.VisibilityConfigProperty.Builder cloudWatchMetricsEnabled(IResolvable cloudWatchMetricsEnabled)

Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getCloudWatchMetricsEnabled()

Parameters:

cloudWatchMetricsEnabled - Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide .

For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide .

Returns:

this

metricName

@Stability(Stable)
public CfnWebACLPropsMixin.VisibilityConfigProperty.Builder metricName(String metricName)

Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getMetricName()

Parameters:

metricName - A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF , for example All and Default_Action .

Returns:

this

sampledRequestsEnabled

@Stability(Stable)
public CfnWebACLPropsMixin.VisibilityConfigProperty.Builder sampledRequestsEnabled(Boolean sampledRequestsEnabled)

Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getSampledRequestsEnabled()

Parameters:

sampledRequestsEnabled - Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.

If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.

Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect 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.

Returns:

this

sampledRequestsEnabled

@Stability(Stable)
public CfnWebACLPropsMixin.VisibilityConfigProperty.Builder sampledRequestsEnabled(IResolvable sampledRequestsEnabled)

Sets the value of CfnWebACLPropsMixin.VisibilityConfigProperty.getSampledRequestsEnabled()

Parameters:

sampledRequestsEnabled - Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.

If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.

Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect 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.

Returns:

this

build

@Stability(Stable)
public CfnWebACLPropsMixin.VisibilityConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnWebACLPropsMixin.VisibilityConfigProperty>

Returns:

a new instance of CfnWebACLPropsMixin.VisibilityConfigProperty

Throws:

NullPointerException - if any required attribute was not provided