com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupByteMatchStatement.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.wafv2.kotlin.outputs

import com.pulumi.awsnative.wafv2.kotlin.enums.RuleGroupPositionalConstraint
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 * Byte Match statement.
 * @property fieldToMatch The part of the web request that you want AWS WAF to inspect.
 * @property positionalConstraint The area within the portion of the web request that you want AWS WAF to search for `SearchString` . Valid values include the following:
 * *CONTAINS*
 * The specified part of the web request must include the value of `SearchString` , but the location doesn't matter.
 * *CONTAINS_WORD*
 * The specified part of the web request must include the value of `SearchString` , and `SearchString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, `SearchString` must be a word, which means that both of the following are true:
 * - `SearchString` is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and `;BadBot` .
 * - `SearchString` is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, `BadBot;` and `-BadBot;` .
 * *EXACTLY*
 * The value of the specified part of the web request must exactly match the value of `SearchString` .
 * *STARTS_WITH*
 * The value of `SearchString` must appear at the beginning of the specified part of the web request.
 * *ENDS_WITH*
 * The value of `SearchString` must appear at the end of the specified part of the web request.
 * @property searchString A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch` . The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.
 * Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.
 * For example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent` . If you want to search the `User-Agent` header for the value `BadBot` , you provide the string `BadBot` in the value of `SearchString` .
 * You must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement` .
 * @property searchStringBase64 String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in `SearchString` instead.
 * You must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement` .
 * @property textTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by `FieldToMatch` , starting from the lowest priority setting, before inspecting the content for a match.
 */
public data class RuleGroupByteMatchStatement(
    public val fieldToMatch: RuleGroupFieldToMatch,
    public val positionalConstraint: RuleGroupPositionalConstraint,
    public val searchString: String? = null,
    public val searchStringBase64: String? = null,
    public val textTransformations: List,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.wafv2.outputs.RuleGroupByteMatchStatement): RuleGroupByteMatchStatement = RuleGroupByteMatchStatement(
            fieldToMatch = javaType.fieldToMatch().let({ args0 ->
                com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupFieldToMatch.Companion.toKotlin(args0)
            }),
            positionalConstraint = javaType.positionalConstraint().let({ args0 ->
                com.pulumi.awsnative.wafv2.kotlin.enums.RuleGroupPositionalConstraint.Companion.toKotlin(args0)
            }),
            searchString = javaType.searchString().map({ args0 -> args0 }).orElse(null),
            searchStringBase64 = javaType.searchStringBase64().map({ args0 -> args0 }).orElse(null),
            textTransformations = javaType.textTransformations().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupTextTransformation.Companion.toKotlin(args0)
                })
            }),
        )
    }
}