quicksight/aws.sdk.kotlin.services.quicksight.model/User

User

class User

A registered user of Quick Sight.

Types

Builder

class Builder

Companion

object Companion

Properties

active

val active: Boolean

The active status of user. When you create an Quick Sight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

arn

val arn: String?

The Amazon Resource Name (ARN) for the user.

customPermissionsName

val customPermissionsName: String?

The custom permissions profile associated with this user.

val email: String?

The user's email address.

externalLoginFederationProviderType

val externalLoginFederationProviderType: String?

The type of supported external login provider that provides identity to let the user federate into Quick Sight with an associated IAM role. The type can be one of the following.

externalLoginFederationProviderUrl

val externalLoginFederationProviderUrl: String?

The URL of the external login provider.

externalLoginId

val externalLoginId: String?

The identity ID for the user in the external login provider.

identityType

val identityType: IdentityType?

The type of identity authentication used by the user.

principalId

val principalId: String?

The principal ID of the user.

role

val role: UserRole?

The Quick Sight role for the user. The user role can be one of the following:.

userName

val userName: String?

The user's user name. This value is required if you are registering a user that will be managed in Quick Sight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String