Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.RateBasedStatementCustomKeyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.RateBasedStatementCustomKeyProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(Stable)
public static interface CfnWebACL.RateBasedStatementCustomKeyProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a single custom aggregate key for a rate-base rule.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

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.wafv2.*;
 Object forwardedIp;
 Object httpMethod;
 Object ip;
 RateBasedStatementCustomKeyProperty rateBasedStatementCustomKeyProperty = RateBasedStatementCustomKeyProperty.builder()
         .cookie(RateLimitCookieProperty.builder()
                 .name("name")
                 .textTransformations(List.of(TextTransformationProperty.builder()
                         .priority(123)
                         .type("type")
                         .build()))
                 .build())
         .forwardedIp(forwardedIp)
         .header(RateLimitHeaderProperty.builder()
                 .name("name")
                 .textTransformations(List.of(TextTransformationProperty.builder()
                         .priority(123)
                         .type("type")
                         .build()))
                 .build())
         .httpMethod(httpMethod)
         .ip(ip)
         .labelNamespace(RateLimitLabelNamespaceProperty.builder()
                 .namespace("namespace")
                 .build())
         .queryArgument(RateLimitQueryArgumentProperty.builder()
                 .name("name")
                 .textTransformations(List.of(TextTransformationProperty.builder()
                         .priority(123)
                         .type("type")
                         .build()))
                 .build())
         .queryString(RateLimitQueryStringProperty.builder()
                 .textTransformations(List.of(TextTransformationProperty.builder()
                         .priority(123)
                         .type("type")
                         .build()))
                 .build())
         .uriPath(RateLimitUriPathProperty.builder()
                 .textTransformations(List.of(TextTransformationProperty.builder()
                         .priority(123)
                         .type("type")
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.RateBasedStatementCustomKeyProperty.Builder	builder()
default Object	getCookie()	Use the value of a cookie in the request as an aggregate key.
default Object	getForwardedIp()	Use the first IP address in an HTTP header as an aggregate key.
default Object	getHeader()	Use the value of a header in the request as an aggregate key.
default Object	getHttpMethod()	Use the request's HTTP method as an aggregate key.
default Object	getIp()	Use the request's originating IP address as an aggregate key.
default Object	getLabelNamespace()	Use the specified label namespace as an aggregate key.
default Object	getQueryArgument()	Use the specified query argument as an aggregate key.
default Object	getQueryString()	Use the request's query string as an aggregate key.
default Object	getUriPath()	Use the request's URI path as an aggregate key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCookie

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

Use the value of a cookie in the request as an aggregate key.

Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-cookie

getForwardedIp

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

Use the first IP address in an HTTP header as an aggregate key.

Each distinct forwarded IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType .

With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-forwardedip

getHeader

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

Use the value of a header in the request as an aggregate key.

Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-header

getHttpMethod

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

Use the request's HTTP method as an aggregate key.

Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-httpmethod

getIp

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

Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-ip

getLabelNamespace

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

Use the specified label namespace as an aggregate key.

Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-labelnamespace

getQueryArgument

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

Use the specified query argument as an aggregate key.

Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-queryargument

getQueryString

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

Use the request's query string as an aggregate key.

Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-querystring

getUriPath

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

Use the request's URI path as an aggregate key.

Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatementcustomkey.html#cfn-wafv2-webacl-ratebasedstatementcustomkey-uripath

builder

@Stability(Stable)
static CfnWebACL.RateBasedStatementCustomKeyProperty.Builder builder()

Returns:

a CfnWebACL.RateBasedStatementCustomKeyProperty.Builder of CfnWebACL.RateBasedStatementCustomKeyProperty