software.amazon.awscdk.services.waf.regional

Interface CfnWebACLProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACLProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.673Z")
 @Stability(value=Stable)
public interface CfnWebACLProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnWebACL`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.waf.regional.*;
 CfnWebACLProps cfnWebACLProps = CfnWebACLProps.builder()
         .defaultAction(ActionProperty.builder()
                 .type("type")
                 .build())
         .metricName("metricName")
         .name("name")
         // the properties below are optional
         .rules(List.of(RuleProperty.builder()
                 .action(ActionProperty.builder()
                         .type("type")
                         .build())
                 .priority(123)
                 .ruleId("ruleId")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWebACLProps.Builder	builder()
Object	getDefaultAction() The action to perform if none of the `Rules` contained in the `WebACL` match.
String	getMetricName() A name for the metrics for this `WebACL` .
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 Detail

getDefaultAction

@Stability(value=Stable)
 @NotNull
Object getDefaultAction()

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

The action is specified by the WafAction object.

getMetricName

@Stability(value=Stable)
 @NotNull
String getMetricName()

A name for 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 .

getName

@Stability(value=Stable)
 @NotNull
String getName()

A friendly name or description of the `WebACL` .

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

getRules

@Stability(value=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` .

builder

@Stability(value=Stable)
static CfnWebACLProps.Builder builder()

Returns:

a CfnWebACLProps.Builder of CfnWebACLProps