commonMain.aws.sdk.kotlin.services.waf.model.RuleGroup.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
The AWS SDK for Kotlin client for WAF
There is a newer version: 1.3.76
// 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.
 *
 * A collection of predefined rules that you can add to a web ACL.
 *
 * Rule groups are subject to the following limits:
 * + Three rule groups per account. You can request an increase to this limit by contacting customer support.
 * + One rule group per web ACL.
 * + Ten rules per rule group.
 */
public class RuleGroup private constructor(builder: Builder) {
    /**
     * A friendly name or description for the metrics for this `RuleGroup`. 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 `RuleGroup`.
     */
    public val metricName: kotlin.String? = builder.metricName
    /**
     * The friendly name or description for the `RuleGroup`. You can't change the name of a `RuleGroup` after you create it.
     */
    public val name: kotlin.String? = builder.name
    /**
     * A unique identifier for a `RuleGroup`. You use `RuleGroupId` to get more information about a `RuleGroup` (see GetRuleGroup), update a `RuleGroup` (see UpdateRuleGroup), insert a `RuleGroup` into a `WebACL` or delete a one from a `WebACL` (see UpdateWebACL), or delete a `RuleGroup` from AWS WAF (see DeleteRuleGroup).
     *
     * `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.
     */
    public val ruleGroupId: kotlin.String = requireNotNull(builder.ruleGroupId) { "A non-null value must be provided for ruleGroupId" }

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

    override fun toString(): kotlin.String = buildString {
        append("RuleGroup(")
        append("metricName=$metricName,")
        append("name=$name,")
        append("ruleGroupId=$ruleGroupId")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = metricName?.hashCode() ?: 0
        result = 31 * result + (name?.hashCode() ?: 0)
        result = 31 * result + (ruleGroupId.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 RuleGroup

        if (metricName != other.metricName) return false
        if (name != other.name) return false
        if (ruleGroupId != other.ruleGroupId) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * A friendly name or description for the metrics for this `RuleGroup`. 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 `RuleGroup`.
         */
        public var metricName: kotlin.String? = null
        /**
         * The friendly name or description for the `RuleGroup`. You can't change the name of a `RuleGroup` after you create it.
         */
        public var name: kotlin.String? = null
        /**
         * A unique identifier for a `RuleGroup`. You use `RuleGroupId` to get more information about a `RuleGroup` (see GetRuleGroup), update a `RuleGroup` (see UpdateRuleGroup), insert a `RuleGroup` into a `WebACL` or delete a one from a `WebACL` (see UpdateWebACL), or delete a `RuleGroup` from AWS WAF (see DeleteRuleGroup).
         *
         * `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.
         */
        public var ruleGroupId: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.waf.model.RuleGroup) : this() {
            this.metricName = x.metricName
            this.name = x.name
            this.ruleGroupId = x.ruleGroupId
        }

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

        internal fun correctErrors(): Builder {
            if (ruleGroupId == null) ruleGroupId = ""
            return this
        }
    }
}