Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.RateBasedStatementCustomKeyProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.wafv2.CfnRuleGroup.RateBasedStatementCustomKeyProperty.Jsii$Proxy

All Implemented Interfaces:

CfnRuleGroup.RateBasedStatementCustomKeyProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnRuleGroup.RateBasedStatementCustomKeyProperty

@Stability(Stable)
@Internal
public static final class CfnRuleGroup.RateBasedStatementCustomKeyProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnRuleGroup.RateBasedStatementCustomKeyProperty

An implementation for CfnRuleGroup.RateBasedStatementCustomKeyProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.wafv2.CfnRuleGroup.RateBasedStatementCustomKeyProperty

CfnRuleGroup.RateBasedStatementCustomKeyProperty.Builder, CfnRuleGroup.RateBasedStatementCustomKeyProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnRuleGroup.RateBasedStatementCustomKeyProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnRuleGroup.RateBasedStatementCustomKeyProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAsn()	Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key.
final Object	getCookie()	Use the value of a cookie in the request as an aggregate key.
final Object	getForwardedIp()	Use the first IP address in an HTTP header as an aggregate key.
final Object	getHeader()	Use the value of a header in the request as an aggregate key.
final Object	getHttpMethod()	Use the request's HTTP method as an aggregate key.
final Object	getIp()	Use the request's originating IP address as an aggregate key.
final Object	getJa3Fingerprint()	Use the request's JA3 fingerprint as an aggregate key.
final Object	getJa4Fingerprint()	Use the request's JA4 fingerprint as an aggregate key.
final Object	getLabelNamespace()	Use the specified label namespace as an aggregate key.
final Object	getQueryArgument()	Use the specified query argument as an aggregate key.
final Object	getQueryString()	Use the request's query string as an aggregate key.
final Object	getUriPath()	Use the request's URI path as an aggregate key.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnRuleGroup.RateBasedStatementCustomKeyProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnRuleGroup.RateBasedStatementCustomKeyProperty.Builder.

Method Details

getAsn

public final Object getAsn()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key.

Each distinct ASN contributes to the aggregation instance.

Specified by:

getAsn in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getCookie

public final Object getCookie()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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.

Returns union: either IResolvable or CfnRuleGroup.RateLimitCookieProperty

Specified by:

getCookie in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getForwardedIp

public final Object getForwardedIp()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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.

Specified by:

getForwardedIp in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getHeader

public final Object getHeader()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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.

Returns union: either IResolvable or CfnRuleGroup.RateLimitHeaderProperty

Specified by:

getHeader in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getHttpMethod

public final Object getHttpMethod()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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.

Specified by:

getHttpMethod in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getIp

public final Object getIp()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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 .

Specified by:

getIp in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getJa3Fingerprint

public final Object getJa3Fingerprint()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

Use the request's JA3 fingerprint as an aggregate key.

If you use a single JA3 fingerprint as your custom key, then each value fully defines an aggregation instance.

Returns union: either IResolvable or CfnRuleGroup.RateLimitJA3FingerprintProperty

Specified by:

getJa3Fingerprint in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getJa4Fingerprint

public final Object getJa4Fingerprint()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

Use the request's JA4 fingerprint as an aggregate key.

If you use a single JA4 fingerprint as your custom key, then each value fully defines an aggregation instance.

Returns union: either IResolvable or CfnRuleGroup.RateLimitJA4FingerprintProperty

Specified by:

getJa4Fingerprint in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getLabelNamespace

public final Object getLabelNamespace()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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 .

Returns union: either IResolvable or CfnRuleGroup.RateLimitLabelNamespaceProperty

Specified by:

getLabelNamespace in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getQueryArgument

public final Object getQueryArgument()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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.

Returns union: either IResolvable or CfnRuleGroup.RateLimitQueryArgumentProperty

Specified by:

getQueryArgument in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getQueryString

public final Object getQueryString()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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.

Returns union: either IResolvable or CfnRuleGroup.RateLimitQueryStringProperty

Specified by:

getQueryString in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

getUriPath

public final Object getUriPath()

Description copied from interface: CfnRuleGroup.RateBasedStatementCustomKeyProperty

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.

Returns union: either IResolvable or CfnRuleGroup.RateLimitUriPathProperty

Specified by:

getUriPath in interface CfnRuleGroup.RateBasedStatementCustomKeyProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object