Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.FieldToMatchProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnRuleGroup.FieldToMatchProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnRuleGroup.FieldToMatchProperty

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

An implementation for CfnRuleGroup.FieldToMatchProperty

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

CfnRuleGroup.FieldToMatchProperty.Builder, CfnRuleGroup.FieldToMatchProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnRuleGroup.FieldToMatchProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnRuleGroup.FieldToMatchProperty.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	getAllQueryArguments()	Inspect all query arguments.
final Object	getBody()	Inspect the request body as plain text.
final Object	getCookies()	Inspect the request cookies.
final Object	getHeaders()	Inspect the request headers.
final Object	getJa3Fingerprint()	Available for use with Amazon CloudFront distributions and Application Load Balancers.
final Object	getJsonBody()	Inspect the request body as JSON.
final Object	getMethod()	Inspect the HTTP method.
final Object	getQueryString()	Inspect the query string.
final Object	getSingleHeader()	Inspect a single header.
final Object	getSingleQueryArgument()	Inspect a single query argument.
final Object	getUriPath()	Inspect the request URI path.
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.FieldToMatchProperty.Builder builder)

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

Method Details

getAllQueryArguments

public final Object getAllQueryArguments()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect all query arguments.

Specified by:

getAllQueryArguments in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getBody

public final Object getBody()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect the request body as plain text.

The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.

• For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
• For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig , for additional processing fees.

For information about how to handle oversized request bodies, see the Body object configuration.

Specified by:

getBody in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getCookies

public final Object getCookies()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect the request cookies.

You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

Specified by:

getCookies in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getHeaders

public final Object getHeaders()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect the request headers.

You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that AWS WAF inspects.

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

Specified by:

getHeaders in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getJa3Fingerprint

public final Object getJa3Fingerprint()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Available for use with Amazon CloudFront distributions and Application Load Balancers.

Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY .

You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .

Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

Specified by:

getJa3Fingerprint in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getJsonBody

public final Object getJsonBody()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect the request body as JSON.

The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.

• For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
• For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig , for additional processing fees.

For information about how to handle oversized request bodies, see the JsonBody object configuration.

Specified by:

getJsonBody in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getMethod

public final Object getMethod()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect the HTTP method.

The method indicates the type of operation that the request is asking the origin to perform.

Specified by:

getMethod in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getQueryString

public final Object getQueryString()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect the query string.

This is the part of a URL that appears after a ? character, if any.

Specified by:

getQueryString in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getSingleHeader

public final Object getSingleHeader()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect a single header.

Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

Example JSON: "SingleHeader": { "Name": "haystack" }

Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

Specified by:

getSingleHeader in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getSingleQueryArgument

public final Object getSingleQueryArgument()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect a single query argument.

Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

Specified by:

getSingleQueryArgument in interface CfnRuleGroup.FieldToMatchProperty

See Also:

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

getUriPath

public final Object getUriPath()

Description copied from interface: CfnRuleGroup.FieldToMatchProperty

Inspect the request URI path.

This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

Specified by:

getUriPath in interface CfnRuleGroup.FieldToMatchProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-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