CfnSizeConstraintSetPropsMixin

class aws_cdk.mixins_preview.aws_waf.mixins.CfnSizeConstraintSetPropsMixin(props, *, strategy=None)

Bases: Mixin

AWS WAF Classic support will end on September 30, 2025.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

see:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html

cloudformationResource:

AWS::WAF::SizeConstraintSet

mixin:

true

exampleMetadata:

fixture=_generated

Example:
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_waf import mixins as waf_mixins

cfn_size_constraint_set_props_mixin = waf_mixins.CfnSizeConstraintSetPropsMixin(waf_mixins.CfnSizeConstraintSetMixinProps(
    name="name",
    size_constraints=[waf_mixins.CfnSizeConstraintSetPropsMixin.SizeConstraintProperty(
        comparison_operator="comparisonOperator",
        field_to_match=waf_mixins.CfnSizeConstraintSetPropsMixin.FieldToMatchProperty(
            data="data",
            type="type"
        ),
        size=123,
        text_transformation="textTransformation"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::WAF::SizeConstraintSet.

Parameters:

props (Union[CfnSizeConstraintSetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['name', 'sizeConstraints']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

FieldToMatchProperty

class CfnSizeConstraintSetPropsMixin.FieldToMatchProperty(*, data=None, type=None)

Bases: object

The part of a web request that you want to inspect, such as a specified header or a query string.

Parameters:

data (Optional[str]) – When the value of Type is HEADER , enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer . The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG , enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion . The parameter name is not case sensitive. If the value of Type is any other value, omit Data .
type (Optional[str]) – The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: - HEADER : A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data . - METHOD : The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT . - QUERY_STRING : A query string, which is the part of a URL that appears after a ? character, if any. - URI : The part of a web request that identifies a resource, for example, /images/daily-ad.jpg . - BODY : 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. - SINGLE_QUERY_ARG : The parameter in the query string that you will inspect, such as UserName or SalesRegion . The maximum length for SINGLE_QUERY_ARG is 30 characters. - ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-fieldtomatch.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_waf import mixins as waf_mixins

field_to_match_property = waf_mixins.CfnSizeConstraintSetPropsMixin.FieldToMatchProperty(
    data="data",
    type="type"
)

Attributes

data

When the value of Type is HEADER , enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer .

The name of the header is not case sensitive.

When the value of Type is SINGLE_QUERY_ARG , enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion . The parameter name is not case sensitive.

If the value of Type is any other value, omit Data .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-fieldtomatch.html#cfn-waf-sizeconstraintset-fieldtomatch-data

type

The part of the web request that you want AWS WAF to search for a specified string.

Parts of a request that you can search include the following:

HEADER : A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data .
METHOD : The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT .
QUERY_STRING : A query string, which is the part of a URL that appears after a ? character, if any.
URI : The part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
BODY : 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set.
SINGLE_QUERY_ARG : The parameter in the query string that you will inspect, such as UserName or SalesRegion . The maximum length for SINGLE_QUERY_ARG is 30 characters.
ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-fieldtomatch.html#cfn-waf-sizeconstraintset-fieldtomatch-type

SizeConstraintProperty

class CfnSizeConstraintSetPropsMixin.SizeConstraintProperty(*, comparison_operator=None, field_to_match=None, size=None, text_transformation=None)

Bases: object

AWS WAF Classic support will end on September 30, 2025.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size , ComparisonOperator , and FieldToMatch to build an expression in the form of “ Size ComparisonOperator size in bytes of FieldToMatch “. If that expression is true, the SizeConstraint is considered to match.

Attributes

comparison_operator

The type of comparison you want AWS WAF to perform.

AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of “ Size ComparisonOperator size in bytes of FieldToMatch “. If that expression is true, the SizeConstraint is considered to match.

EQ : Used to test if the Size is equal to the size of the FieldToMatch

NE : Used to test if the Size is not equal to the size of the FieldToMatch

LE : Used to test if the Size is less than or equal to the size of the FieldToMatch

LT : Used to test if the Size is strictly less than the size of the FieldToMatch

GE : Used to test if the Size is greater than or equal to the size of the FieldToMatch

GT : Used to test if the Size is strictly greater than the size of the FieldToMatch

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-comparisonoperator

field_to_match

The part of a web request that you want to inspect, such as a specified header or a query string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch

size

The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch .

AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of “ Size ComparisonOperator size in bytes of FieldToMatch “. If that expression is true, the SizeConstraint is considered to match.

Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

If you specify URI for the value of Type , the / in the URI path that you specify counts as one character. For example, the URI /logo.jpg is nine characters long.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-size

text_transformation

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF .

If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

You can only specify a single type of TextTransformation.

Note that if you choose BODY for the value of Type , you must choose NONE for TextTransformation because Amazon CloudFront forwards only the first 8192 bytes for inspection.

NONE

Specify NONE if you don’t want to perform any text transformations.

CMD_LINE

When you’re concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

Delete the following characters: “ ‘ ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

f, formfeed, decimal 12
t, tab, decimal 9
n, newline, decimal 10
r, carriage return, decimal 13
v, vertical tab, decimal 11
non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

Replaces (ampersand)quot; with "
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a “less than” symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-texttransformation