software.amazon.awscdk.services.waf.regional

Interface CfnRateBasedRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRateBasedRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:08.217Z")
 @Stability(value=Stable)
public interface CfnRateBasedRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::WAFRegional::RateBasedRule`.

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.*;
 CfnRateBasedRuleProps cfnRateBasedRuleProps = CfnRateBasedRuleProps.builder()
         .metricName("metricName")
         .name("name")
         .rateKey("rateKey")
         .rateLimit(123)
         // the properties below are optional
         .matchPredicates(List.of(PredicateProperty.builder()
                 .dataId("dataId")
                 .negated(false)
                 .type("type")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRateBasedRuleProps.Builder	builder()
default Object	getMatchPredicates() `AWS::WAFRegional::RateBasedRule.MatchPredicates`.
String	getMetricName() `AWS::WAFRegional::RateBasedRule.MetricName`.
String	getName() `AWS::WAFRegional::RateBasedRule.Name`.
String	getRateKey() `AWS::WAFRegional::RateBasedRule.RateKey`.
Number	getRateLimit() `AWS::WAFRegional::RateBasedRule.RateLimit`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMatchPredicates

@Stability(value=Stable)
 @Nullable
default Object getMatchPredicates()

`AWS::WAFRegional::RateBasedRule.MatchPredicates`.

getMetricName

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

`AWS::WAFRegional::RateBasedRule.MetricName`.

getName

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

`AWS::WAFRegional::RateBasedRule.Name`.

getRateKey

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

`AWS::WAFRegional::RateBasedRule.RateKey`.

getRateLimit

@Stability(value=Stable)
 @NotNull
Number getRateLimit()

`AWS::WAFRegional::RateBasedRule.RateLimit`.

builder

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

Returns:

a CfnRateBasedRuleProps.Builder of CfnRateBasedRuleProps