commonMain.aws.sdk.kotlin.services.wafv2.model.JsonBody.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wafv2-jvm Show documentation
The AWS Kotlin client for WAFV2
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.wafv2.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Inspect the body of the web request as JSON. The body immediately follows the request headers.
 *
 * This is used to indicate the web request component to inspect, in the FieldToMatch specification.
 *
 * Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
 *
 * Example JSON: `"JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }`
 *
 * For additional information about this request component option, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the *WAF Developer Guide*.
 */
public class JsonBody private constructor(builder: Builder) {
    /**
     * What WAF should do if it fails to completely parse the JSON body. The options are the following:
     * + `EVALUATE_AS_STRING` - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
     * + `MATCH` - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
     * + `NO_MATCH` - Treat the web request as not matching the rule statement.
     *
     * If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
     *
     * WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the *WAF Developer Guide*.
     */
    public val invalidFallbackBehavior: aws.sdk.kotlin.services.wafv2.model.BodyParsingFallbackBehavior? = builder.invalidFallbackBehavior
    /**
     * The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
     */
    public val matchPattern: aws.sdk.kotlin.services.wafv2.model.JsonMatchPattern? = builder.matchPattern
    /**
     * The parts of the JSON to match against using the `MatchPattern`. If you specify `ALL`, WAF matches against keys and values.
     *
     * `All` does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.
     */
    public val matchScope: aws.sdk.kotlin.services.wafv2.model.JsonMatchScope = requireNotNull(builder.matchScope) { "A non-null value must be provided for matchScope" }
    /**
     * What WAF should do if the body is larger than WAF can inspect.
     *
     * 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 WAF for inspection.
     * + For Application Load Balancer and 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.
     *
     * The options for oversize handling are the following:
     * + `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.
     * + `MATCH` - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
     * + `NO_MATCH` - Treat the web request as not matching the rule statement.
     *
     * You can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
     *
     * Default: `CONTINUE`
     */
    public val oversizeHandling: aws.sdk.kotlin.services.wafv2.model.OversizeHandling? = builder.oversizeHandling

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.wafv2.model.JsonBody = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("JsonBody(")
        append("invalidFallbackBehavior=$invalidFallbackBehavior,")
        append("matchPattern=$matchPattern,")
        append("matchScope=$matchScope,")
        append("oversizeHandling=$oversizeHandling")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = invalidFallbackBehavior?.hashCode() ?: 0
        result = 31 * result + (matchPattern?.hashCode() ?: 0)
        result = 31 * result + (matchScope.hashCode())
        result = 31 * result + (oversizeHandling?.hashCode() ?: 0)
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as JsonBody

        if (invalidFallbackBehavior != other.invalidFallbackBehavior) return false
        if (matchPattern != other.matchPattern) return false
        if (matchScope != other.matchScope) return false
        if (oversizeHandling != other.oversizeHandling) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.wafv2.model.JsonBody = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * What WAF should do if it fails to completely parse the JSON body. The options are the following:
         * + `EVALUATE_AS_STRING` - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
         * + `MATCH` - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
         * + `NO_MATCH` - Treat the web request as not matching the rule statement.
         *
         * If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
         *
         * WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the *WAF Developer Guide*.
         */
        public var invalidFallbackBehavior: aws.sdk.kotlin.services.wafv2.model.BodyParsingFallbackBehavior? = null
        /**
         * The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
         */
        public var matchPattern: aws.sdk.kotlin.services.wafv2.model.JsonMatchPattern? = null
        /**
         * The parts of the JSON to match against using the `MatchPattern`. If you specify `ALL`, WAF matches against keys and values.
         *
         * `All` does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.
         */
        public var matchScope: aws.sdk.kotlin.services.wafv2.model.JsonMatchScope? = null
        /**
         * What WAF should do if the body is larger than WAF can inspect.
         *
         * 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 WAF for inspection.
         * + For Application Load Balancer and 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.
         *
         * The options for oversize handling are the following:
         * + `CONTINUE` - Inspect the available body contents normally, according to the rule inspection criteria.
         * + `MATCH` - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
         * + `NO_MATCH` - Treat the web request as not matching the rule statement.
         *
         * You can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
         *
         * Default: `CONTINUE`
         */
        public var oversizeHandling: aws.sdk.kotlin.services.wafv2.model.OversizeHandling? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.wafv2.model.JsonBody) : this() {
            this.invalidFallbackBehavior = x.invalidFallbackBehavior
            this.matchPattern = x.matchPattern
            this.matchScope = x.matchScope
            this.oversizeHandling = x.oversizeHandling
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.wafv2.model.JsonBody = JsonBody(this)

        /**
         * construct an [aws.sdk.kotlin.services.wafv2.model.JsonMatchPattern] inside the given [block]
         */
        public fun matchPattern(block: aws.sdk.kotlin.services.wafv2.model.JsonMatchPattern.Builder.() -> kotlin.Unit) {
            this.matchPattern = aws.sdk.kotlin.services.wafv2.model.JsonMatchPattern.invoke(block)
        }

        internal fun correctErrors(): Builder {
            if (matchScope == null) matchScope = JsonMatchScope.SdkUnknown("no value provided")
            return this
        }
    }
}