Package software.amazon.awscdk.cfnpropertymixins.services.waf

Interface CfnWebACLMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACLMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.993Z")
@Stability(Stable)
public interface CfnWebACLMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnWebACLPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.waf.*;
 CfnWebACLMixinProps cfnWebACLMixinProps = CfnWebACLMixinProps.builder()
         .defaultAction(WafActionProperty.builder()
                 .type("type")
                 .build())
         .metricName("metricName")
         .name("name")
         .rules(List.of(ActivatedRuleProperty.builder()
                 .action(WafActionProperty.builder()
                         .type("type")
                         .build())
                 .priority(123)
                 .ruleId("ruleId")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebACLMixinProps.Builder	A builder for CfnWebACLMixinProps
static final class	CfnWebACLMixinProps.Jsii$Proxy	An implementation for CfnWebACLMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnWebACLMixinProps.Builder	builder()
default Object	getDefaultAction()	The action to perform if none of the Rules contained in the WebACL match.
default String	getMetricName()	The name of the metrics for this WebACL .
default String	getName()	A friendly name or description of the WebACL .
default Object	getRules()	An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultAction

@Stability(Stable)
@Nullable
default Object getDefaultAction()

The action to perform if none of the Rules contained in the WebACL match.

The action is specified by the WafAction object.

Returns union: either IResolvable or CfnWebACLPropsMixin.WafActionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-defaultaction

getMetricName

@Stability(Stable)
@Nullable
default String getMetricName()

The name of the metrics for this WebACL .

The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF , including "All" and "Default_Action." You can't change MetricName after you create the WebACL .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-metricname

getName

@Stability(Stable)
@Nullable
default String getName()

A friendly name or description of the WebACL .

You can't change the name of a WebACL after you create it.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-name

getRules

@Stability(Stable)
@Nullable
default Object getRules()

An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWebACLPropsMixin.ActivatedRuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-rules

builder

@Stability(Stable)
static CfnWebACLMixinProps.Builder builder()

Returns:

a CfnWebACLMixinProps.Builder of CfnWebACLMixinProps