commonMain.aws.sdk.kotlin.services.waf.model.RegexMatchTuple.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of waf-jvm Show documentation
Show all versions of waf-jvm Show documentation
The AWS SDK for Kotlin client for WAF
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.waf.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* This is **AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.
*
* **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With the latest version, AWS WAF has a single set of endpoints for regional and global use.
*
* The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each `RegexMatchTuple` object contains:
* + The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the `User-Agent` header.
* + The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
* + Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
*/
public class RegexMatchTuple private constructor(builder: Builder) {
/**
* Specifies where in a web request to look for the `RegexPatternSet`.
*/
public val fieldToMatch: aws.sdk.kotlin.services.waf.model.FieldToMatch? = builder.fieldToMatch
/**
* The `RegexPatternSetId` for a `RegexPatternSet`. You use `RegexPatternSetId` to get information about a `RegexPatternSet` (see GetRegexPatternSet), update a `RegexPatternSet` (see UpdateRegexPatternSet), insert a `RegexPatternSet` into a `RegexMatchSet` or delete one from a `RegexMatchSet` (see UpdateRegexMatchSet), and delete an `RegexPatternSet` from AWS WAF (see DeleteRegexPatternSet).
*
* `RegexPatternSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
public val regexPatternSetId: kotlin.String = requireNotNull(builder.regexPatternSetId) { "A non-null value must be provided for regexPatternSetId" }
/**
* 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 `RegexPatternSet` before inspecting a request for a match.
*
* You can only specify a single type of TextTransformation.
*
* **CMD_LINE**
*
* When you're concerned that attackers are injecting an operating system commandline 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.
*
* **NONE**
*
* Specify `NONE` if you don't want to perform any text transformations.
*/
public val textTransformation: aws.sdk.kotlin.services.waf.model.TextTransformation = requireNotNull(builder.textTransformation) { "A non-null value must be provided for textTransformation" }
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.waf.model.RegexMatchTuple = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("RegexMatchTuple(")
append("fieldToMatch=$fieldToMatch,")
append("regexPatternSetId=$regexPatternSetId,")
append("textTransformation=$textTransformation")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = fieldToMatch?.hashCode() ?: 0
result = 31 * result + (regexPatternSetId.hashCode())
result = 31 * result + (textTransformation.hashCode())
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 RegexMatchTuple
if (fieldToMatch != other.fieldToMatch) return false
if (regexPatternSetId != other.regexPatternSetId) return false
if (textTransformation != other.textTransformation) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.waf.model.RegexMatchTuple = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* Specifies where in a web request to look for the `RegexPatternSet`.
*/
public var fieldToMatch: aws.sdk.kotlin.services.waf.model.FieldToMatch? = null
/**
* The `RegexPatternSetId` for a `RegexPatternSet`. You use `RegexPatternSetId` to get information about a `RegexPatternSet` (see GetRegexPatternSet), update a `RegexPatternSet` (see UpdateRegexPatternSet), insert a `RegexPatternSet` into a `RegexMatchSet` or delete one from a `RegexMatchSet` (see UpdateRegexMatchSet), and delete an `RegexPatternSet` from AWS WAF (see DeleteRegexPatternSet).
*
* `RegexPatternSetId` is returned by CreateRegexPatternSet and by ListRegexPatternSets.
*/
public var regexPatternSetId: kotlin.String? = null
/**
* 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 `RegexPatternSet` before inspecting a request for a match.
*
* You can only specify a single type of TextTransformation.
*
* **CMD_LINE**
*
* When you're concerned that attackers are injecting an operating system commandline 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.
*
* **NONE**
*
* Specify `NONE` if you don't want to perform any text transformations.
*/
public var textTransformation: aws.sdk.kotlin.services.waf.model.TextTransformation? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.waf.model.RegexMatchTuple) : this() {
this.fieldToMatch = x.fieldToMatch
this.regexPatternSetId = x.regexPatternSetId
this.textTransformation = x.textTransformation
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.waf.model.RegexMatchTuple = RegexMatchTuple(this)
/**
* construct an [aws.sdk.kotlin.services.waf.model.FieldToMatch] inside the given [block]
*/
public fun fieldToMatch(block: aws.sdk.kotlin.services.waf.model.FieldToMatch.Builder.() -> kotlin.Unit) {
this.fieldToMatch = aws.sdk.kotlin.services.waf.model.FieldToMatch.invoke(block)
}
internal fun correctErrors(): Builder {
if (regexPatternSetId == null) regexPatternSetId = ""
if (textTransformation == null) textTransformation = TextTransformation.SdkUnknown("no value provided")
return this
}
}
}