opensearch/aws.sdk.kotlin.services.opensearch.model/IdentityCenterOptions

IdentityCenterOptions

class IdentityCenterOptions

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

Types

object Companion

Properties

enabledApiAccess

val enabledApiAccess: Boolean?

Indicates whether IAM Identity Center is enabled for the application.

identityCenterApplicationArn

val identityCenterApplicationArn: String?

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

identityCenterInstanceArn

val identityCenterInstanceArn: String?

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

identityStoreId

val identityStoreId: String?

The identifier of the IAM Identity Store.

val rolesKey: RolesKeyIdCOption?

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

val subjectKey: SubjectKeyIdCOption?

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

Functions

inline fun copy(block: IdentityCenterOptions.Builder.() -> Unit = {}): IdentityCenterOptions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String