commonMain.aws.sdk.kotlin.services.wafv2.model.ManagedRuleSet.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wafv2-jvm Show documentation
The AWS Kotlin client for WAFV2
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.wafv2.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF.
 *
 * This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
 *
 * Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are `ListManagedRuleSets`, `GetManagedRuleSet`, `PutManagedRuleSetVersions`, and `UpdateManagedRuleSetVersionExpiryDate`.
 */
public class ManagedRuleSet private constructor(builder: Builder) {
    /**
     * The Amazon Resource Name (ARN) of the entity.
     */
    public val arn: kotlin.String = requireNotNull(builder.arn) { "A non-null value must be provided for arn" }
    /**
     * A description of the set that helps with identification.
     */
    public val description: kotlin.String? = builder.description
    /**
     * A unique identifier for the managed rule set. The ID is returned in the responses to commands like `list`. You provide it to operations like `get` and `update`.
     */
    public val id: kotlin.String = requireNotNull(builder.id) { "A non-null value must be provided for id" }
    /**
     * The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
     * + The syntax for the label namespace prefix for a managed rule group is the following: `awswaf:managed::`:
     * + When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: `:`
     */
    public val labelNamespace: kotlin.String? = builder.labelNamespace
    /**
     * The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
     *
     * This name is assigned to the corresponding managed rule group, which your customers can access and use.
     */
    public val name: kotlin.String = requireNotNull(builder.name) { "A non-null value must be provided for name" }
    /**
     * The versions of this managed rule set that are available for use by customers.
     */
    public val publishedVersions: Map? = builder.publishedVersions
    /**
     * The version that you would like your customers to use.
     */
    public val recommendedVersion: kotlin.String? = builder.recommendedVersion

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

    override fun toString(): kotlin.String = buildString {
        append("ManagedRuleSet(")
        append("arn=$arn,")
        append("description=$description,")
        append("id=$id,")
        append("labelNamespace=$labelNamespace,")
        append("name=$name,")
        append("publishedVersions=$publishedVersions,")
        append("recommendedVersion=$recommendedVersion")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = arn.hashCode()
        result = 31 * result + (description?.hashCode() ?: 0)
        result = 31 * result + (id.hashCode())
        result = 31 * result + (labelNamespace?.hashCode() ?: 0)
        result = 31 * result + (name.hashCode())
        result = 31 * result + (publishedVersions?.hashCode() ?: 0)
        result = 31 * result + (recommendedVersion?.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 ManagedRuleSet

        if (arn != other.arn) return false
        if (description != other.description) return false
        if (id != other.id) return false
        if (labelNamespace != other.labelNamespace) return false
        if (name != other.name) return false
        if (publishedVersions != other.publishedVersions) return false
        if (recommendedVersion != other.recommendedVersion) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The Amazon Resource Name (ARN) of the entity.
         */
        public var arn: kotlin.String? = null
        /**
         * A description of the set that helps with identification.
         */
        public var description: kotlin.String? = null
        /**
         * A unique identifier for the managed rule set. The ID is returned in the responses to commands like `list`. You provide it to operations like `get` and `update`.
         */
        public var id: kotlin.String? = null
        /**
         * The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
         * + The syntax for the label namespace prefix for a managed rule group is the following: `awswaf:managed::`:
         * + When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: `:`
         */
        public var labelNamespace: kotlin.String? = null
        /**
         * The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
         *
         * This name is assigned to the corresponding managed rule group, which your customers can access and use.
         */
        public var name: kotlin.String? = null
        /**
         * The versions of this managed rule set that are available for use by customers.
         */
        public var publishedVersions: Map? = null
        /**
         * The version that you would like your customers to use.
         */
        public var recommendedVersion: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.wafv2.model.ManagedRuleSet) : this() {
            this.arn = x.arn
            this.description = x.description
            this.id = x.id
            this.labelNamespace = x.labelNamespace
            this.name = x.name
            this.publishedVersions = x.publishedVersions
            this.recommendedVersion = x.recommendedVersion
        }

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

        internal fun correctErrors(): Builder {
            if (arn == null) arn = ""
            if (id == null) id = ""
            if (name == null) name = ""
            return this
        }
    }
}