commonMain.aws.sdk.kotlin.services.waf.model.CreateRateBasedRuleRequest.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
public class CreateRateBasedRuleRequest private constructor(builder: Builder) {
/**
* The `ChangeToken` that you used to submit the `CreateRateBasedRule` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
public val changeToken: kotlin.String? = builder.changeToken
/**
* A friendly name or description for the metrics for this `RateBasedRule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the `RateBasedRule`.
*/
public val metricName: kotlin.String? = builder.metricName
/**
* A friendly name or description of the RateBasedRule. You can't change the name of a `RateBasedRule` after you create it.
*/
public val name: kotlin.String? = builder.name
/**
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for `RateKey` is `IP`. `IP` indicates that requests that arrive from the same IP address are subject to the `RateLimit` that is specified in the `RateBasedRule`.
*/
public val rateKey: aws.sdk.kotlin.services.waf.model.RateKey? = builder.rateKey
/**
* The maximum number of requests, which have an identical value in the field that is specified by `RateKey`, allowed in a five-minute period. If the number of requests exceeds the `RateLimit` and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
*/
public val rateLimit: kotlin.Long? = builder.rateLimit
/**
*
*/
public val tags: List? = builder.tags
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.waf.model.CreateRateBasedRuleRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreateRateBasedRuleRequest(")
append("changeToken=$changeToken,")
append("metricName=$metricName,")
append("name=$name,")
append("rateKey=$rateKey,")
append("rateLimit=$rateLimit,")
append("tags=$tags")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = changeToken?.hashCode() ?: 0
result = 31 * result + (metricName?.hashCode() ?: 0)
result = 31 * result + (name?.hashCode() ?: 0)
result = 31 * result + (rateKey?.hashCode() ?: 0)
result = 31 * result + (rateLimit?.hashCode() ?: 0)
result = 31 * result + (tags?.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 CreateRateBasedRuleRequest
if (changeToken != other.changeToken) return false
if (metricName != other.metricName) return false
if (name != other.name) return false
if (rateKey != other.rateKey) return false
if (rateLimit != other.rateLimit) return false
if (tags != other.tags) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.waf.model.CreateRateBasedRuleRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The `ChangeToken` that you used to submit the `CreateRateBasedRule` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*/
public var changeToken: kotlin.String? = null
/**
* A friendly name or description for the metrics for this `RateBasedRule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the `RateBasedRule`.
*/
public var metricName: kotlin.String? = null
/**
* A friendly name or description of the RateBasedRule. You can't change the name of a `RateBasedRule` after you create it.
*/
public var name: kotlin.String? = null
/**
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for `RateKey` is `IP`. `IP` indicates that requests that arrive from the same IP address are subject to the `RateLimit` that is specified in the `RateBasedRule`.
*/
public var rateKey: aws.sdk.kotlin.services.waf.model.RateKey? = null
/**
* The maximum number of requests, which have an identical value in the field that is specified by `RateKey`, allowed in a five-minute period. If the number of requests exceeds the `RateLimit` and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
*/
public var rateLimit: kotlin.Long? = null
/**
*
*/
public var tags: List? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.waf.model.CreateRateBasedRuleRequest) : this() {
this.changeToken = x.changeToken
this.metricName = x.metricName
this.name = x.name
this.rateKey = x.rateKey
this.rateLimit = x.rateLimit
this.tags = x.tags
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.waf.model.CreateRateBasedRuleRequest = CreateRateBasedRuleRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}