commonMain.aws.sdk.kotlin.services.kendra.model.UserIdentityConfiguration.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.kendra.model



/**
 * Provides the configuration information for the identifiers of your users.
 */
public class UserIdentityConfiguration private constructor(builder: Builder) {
    /**
     * The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for [user context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see [Getting started with an IAM Identity Center identity source](https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html).
     */
    public val identityAttributeName: kotlin.String? = builder.identityAttributeName

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

    override fun toString(): kotlin.String = buildString {
        append("UserIdentityConfiguration(")
        append("identityAttributeName=$identityAttributeName")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = identityAttributeName?.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 UserIdentityConfiguration

        if (identityAttributeName != other.identityAttributeName) return false

        return true
    }

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

    public class Builder {
        /**
         * The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for [user context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see [Getting started with an IAM Identity Center identity source](https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html).
         */
        public var identityAttributeName: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.kendra.model.UserIdentityConfiguration) : this() {
            this.identityAttributeName = x.identityAttributeName
        }

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

        internal fun correctErrors(): Builder {
            return this
        }
    }
}