com.pulumi.awsnative.wafv2.kotlin.inputs.WebAclJsonBodyArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.wafv2.kotlin.inputs
import com.pulumi.awsnative.wafv2.inputs.WebAclJsonBodyArgs.builder
import com.pulumi.awsnative.wafv2.kotlin.enums.WebAclBodyParsingFallbackBehavior
import com.pulumi.awsnative.wafv2.kotlin.enums.WebAclJsonMatchScope
import com.pulumi.awsnative.wafv2.kotlin.enums.WebAclOversizeHandling
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName
/**
* Inspect the request body as JSON. The request body immediately follows the request headers.
* @property invalidFallbackBehavior What AWS 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. AWS 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. AWS 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, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
* > AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS 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 *AWS WAF Developer Guide* .
* @property matchPattern The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
* @property matchScope The parts of the JSON to match against using the `MatchPattern` . If you specify `ALL` , AWS 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.
* @property oversizeHandling What AWS WAF should do if the body is larger than AWS WAF can inspect.
* 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.
* 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. AWS 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 data class WebAclJsonBodyArgs(
public val invalidFallbackBehavior: Output? = null,
public val matchPattern: Output,
public val matchScope: Output,
public val oversizeHandling: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.wafv2.inputs.WebAclJsonBodyArgs =
com.pulumi.awsnative.wafv2.inputs.WebAclJsonBodyArgs.builder()
.invalidFallbackBehavior(
invalidFallbackBehavior?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.matchPattern(matchPattern.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.matchScope(matchScope.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.oversizeHandling(
oversizeHandling?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
).build()
}
/**
* Builder for [WebAclJsonBodyArgs].
*/
@PulumiTagMarker
public class WebAclJsonBodyArgsBuilder internal constructor() {
private var invalidFallbackBehavior: Output? = null
private var matchPattern: Output? = null
private var matchScope: Output? = null
private var oversizeHandling: Output? = null
/**
* @param value What AWS 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. AWS 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. AWS 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, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
* > AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS 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 *AWS WAF Developer Guide* .
*/
@JvmName("qhxuqtewqqqgmhkl")
public suspend fun invalidFallbackBehavior(`value`: Output) {
this.invalidFallbackBehavior = value
}
/**
* @param value The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
*/
@JvmName("sotkbhtfanbllhta")
public suspend fun matchPattern(`value`: Output) {
this.matchPattern = value
}
/**
* @param value The parts of the JSON to match against using the `MatchPattern` . If you specify `ALL` , AWS 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.
*/
@JvmName("oihminlwridyulsq")
public suspend fun matchScope(`value`: Output) {
this.matchScope = value
}
/**
* @param value What AWS WAF should do if the body is larger than AWS WAF can inspect.
* 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.
* 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. AWS 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`
*/
@JvmName("wccmnwtcwtwwpjsd")
public suspend fun oversizeHandling(`value`: Output) {
this.oversizeHandling = value
}
/**
* @param value What AWS 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. AWS 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. AWS 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, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
* > AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS 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 *AWS WAF Developer Guide* .
*/
@JvmName("rejfjdfkjdiwvrdm")
public suspend fun invalidFallbackBehavior(`value`: WebAclBodyParsingFallbackBehavior?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.invalidFallbackBehavior = mapped
}
/**
* @param value The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
*/
@JvmName("ejmpvgaexxirkgib")
public suspend fun matchPattern(`value`: WebAclJsonMatchPatternArgs) {
val toBeMapped = value
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.matchPattern = mapped
}
/**
* @param argument The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
*/
@JvmName("rmvirfsegqoarwpn")
public suspend fun matchPattern(argument: suspend WebAclJsonMatchPatternArgsBuilder.() -> Unit) {
val toBeMapped = WebAclJsonMatchPatternArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.matchPattern = mapped
}
/**
* @param value The parts of the JSON to match against using the `MatchPattern` . If you specify `ALL` , AWS 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.
*/
@JvmName("dyxtmlakkvcgeuoy")
public suspend fun matchScope(`value`: WebAclJsonMatchScope) {
val toBeMapped = value
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.matchScope = mapped
}
/**
* @param value What AWS WAF should do if the body is larger than AWS WAF can inspect.
* 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.
* 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. AWS 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`
*/
@JvmName("bhdxfqescrsdqbfi")
public suspend fun oversizeHandling(`value`: WebAclOversizeHandling?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.oversizeHandling = mapped
}
internal fun build(): WebAclJsonBodyArgs = WebAclJsonBodyArgs(
invalidFallbackBehavior = invalidFallbackBehavior,
matchPattern = matchPattern ?: throw PulumiNullFieldException("matchPattern"),
matchScope = matchScope ?: throw PulumiNullFieldException("matchScope"),
oversizeHandling = oversizeHandling,
)
}