software.amazon.awssdk.services.wafv2.model

Class SizeConstraintStatement

java.lang.Object

software.amazon.awssdk.services.wafv2.model.SizeConstraintStatement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SizeConstraintStatement.Builder,SizeConstraintStatement>

@Generated(value="software.amazon.awssdk:codegen")
public final class SizeConstraintStatement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SizeConstraintStatement.Builder,SizeConstraintStatement>

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 bytes) and for CloudFront web ACLs, this limit is 16 KB (16,384 bytes). For CloudFront web ACLs, you can increase the limit in the web ACL AssociationConfig, for additional fees. If you know that the request body for your web requests should never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger request body size.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SizeConstraintStatement.Builder

Method Summary

Modifier and Type	Method and Description
static SizeConstraintStatement.Builder	builder()
ComparisonOperator	comparisonOperator() The operator to use to compare the request part to the size setting.
String	comparisonOperatorAsString() The operator to use to compare the request part to the size setting.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FieldToMatch	fieldToMatch() The part of the web request that you want WAF to inspect.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTextTransformations() For responses, this returns true if the service returned a value for the TextTransformations property.
List<SdkField<?>>	sdkFields()
static Class<? extends SizeConstraintStatement.Builder>	serializableBuilderClass()
Long	size() The size, in byte, to compare to the request part, after any transformations.
List<TextTransformation>	textTransformations() Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
SizeConstraintStatement.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fieldToMatch

public final FieldToMatch fieldToMatch()

The part of the web request that you want WAF to inspect.

Returns:

The part of the web request that you want WAF to inspect.

comparisonOperator

public final ComparisonOperator comparisonOperator()

The operator to use to compare the request part to the size setting.

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

The operator to use to compare the request part to the size setting.

See Also:

ComparisonOperator

comparisonOperatorAsString

public final String comparisonOperatorAsString()

The operator to use to compare the request part to the size setting.

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

The operator to use to compare the request part to the size setting.

See Also:

ComparisonOperator

size

public final Long size()

The size, in byte, to compare to the request part, after any transformations.

Returns:

The size, in byte, to compare to the request part, after any transformations.

hasTextTransformations

public final boolean hasTextTransformations()

For responses, this returns true if the service returned a value for the TextTransformations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

textTransformations

public final List<TextTransformation> textTransformations()

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTextTransformations() method.

Returns:

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

toBuilder

public SizeConstraintStatement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SizeConstraintStatement.Builder,SizeConstraintStatement>

builder

public static SizeConstraintStatement.Builder builder()

serializableBuilderClass

public static Class<? extends SizeConstraintStatement.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo