Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.VisibilityConfigProperty.Builder

java.lang.Object
software.amazon.awscdk.services.wafv2.CfnRuleGroup.VisibilityConfigProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnRuleGroup.VisibilityConfigProperty>
Enclosing interface:
CfnRuleGroup.VisibilityConfigProperty
@Stability(Stable) public static final class CfnRuleGroup.VisibilityConfigProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnRuleGroup.VisibilityConfigProperty>
A builder for CfnRuleGroup.VisibilityConfigProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • cloudWatchMetricsEnabled

      @Stability(Stable) public CfnRuleGroup.VisibilityConfigProperty.Builder cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
      Sets the value of CfnRuleGroup.VisibilityConfigProperty.getCloudWatchMetricsEnabled()
      Parameters:
      cloudWatchMetricsEnabled - Indicates whether the associated resource sends metrics to Amazon CloudWatch. This parameter is required. 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 CfnRuleGroup.VisibilityConfigProperty.Builder cloudWatchMetricsEnabled(IResolvable cloudWatchMetricsEnabled)
      Sets the value of CfnRuleGroup.VisibilityConfigProperty.getCloudWatchMetricsEnabled()
      Parameters:
      cloudWatchMetricsEnabled - Indicates whether the associated resource sends metrics to Amazon CloudWatch. This parameter is required. 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 CfnRuleGroup.VisibilityConfigProperty.Builder metricName(String metricName)
      Sets the value of CfnRuleGroup.VisibilityConfigProperty.getMetricName()
      Parameters:
      metricName - A name of the Amazon CloudWatch metric dimension. This parameter is required. 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 CfnRuleGroup.VisibilityConfigProperty.Builder sampledRequestsEnabled(Boolean sampledRequestsEnabled)
      Sets the value of CfnRuleGroup.VisibilityConfigProperty.getSampledRequestsEnabled()
      Parameters:
      sampledRequestsEnabled - Indicates whether AWS WAF should store a sampling of the web requests that match the rules. This parameter is required. You can view the sampled requests through the AWS WAF console.

      Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.

      Returns:
      this

    • sampledRequestsEnabled

      @Stability(Stable) public CfnRuleGroup.VisibilityConfigProperty.Builder sampledRequestsEnabled(IResolvable sampledRequestsEnabled)
      Sets the value of CfnRuleGroup.VisibilityConfigProperty.getSampledRequestsEnabled()
      Parameters:
      sampledRequestsEnabled - Indicates whether AWS WAF should store a sampling of the web requests that match the rules. This parameter is required. You can view the sampled requests through the AWS WAF console.

      Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.

      Returns:
      this

    • build

      @Stability(Stable) public CfnRuleGroup.VisibilityConfigProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnRuleGroup.VisibilityConfigProperty>
      Returns:
      a new instance of CfnRuleGroup.VisibilityConfigProperty
      Throws:
      NullPointerException - if any required attribute was not provided