Package software.amazon.awscdk.services.waf

Interface CfnRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.768Z")
@Stability(Stable)
public interface CfnRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRule.

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.*;
 CfnRuleProps cfnRuleProps = CfnRuleProps.builder()
         .metricName("metricName")
         .name("name")
         // the properties below are optional
         .predicates(List.of(PredicateProperty.builder()
                 .dataId("dataId")
                 .negated(false)
                 .type("type")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRuleProps.Builder	builder()
String	getMetricName()	The name of the metrics for this Rule .
String	getName()	The friendly name or description for the Rule .
default Object	getPredicates()	The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet object that you want to include in a Rule .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

The name of the metrics for this Rule .

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

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The friendly name or description for the Rule .

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

See Also:

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

getPredicates

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

The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet object that you want to include in a Rule .

See Also:

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

builder

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

Returns:

a CfnRuleProps.Builder of CfnRuleProps