You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppStream::Types::User

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a user in the user pool.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the user.

Returns:

  • (String) —

    The ARN of the user.

#authentication_type ⇒ String

The authentication type for the user.

Possible values:

  • API
  • SAML
  • USERPOOL

Returns:

  • (String) —

    The authentication type for the user.

#created_time ⇒ Time

The date and time the user was created in the user pool.

Returns:

  • (Time) —

    The date and time the user was created in the user pool.

#enabled ⇒ Boolean

Specifies whether the user in the user pool is enabled.

Returns:

  • (Boolean) —

    Specifies whether the user in the user pool is enabled.

#first_name ⇒ String

The first name, or given name, of the user.

Returns:

  • (String) —

    The first name, or given name, of the user.

#last_name ⇒ String

The last name, or surname, of the user.

Returns:

  • (String) —

    The last name, or surname, of the user.

#status ⇒ String

The status of the user in the user pool. The status can be one of the following:

  • UNCONFIRMED – The user is created but not confirmed.

  • CONFIRMED – The user is confirmed.

  • ARCHIVED – The user is no longer active.

  • COMPROMISED – The user is disabled because of a potential security threat.

  • UNKNOWN – The user status is not known.

Returns:

  • (String) —

    The status of the user in the user pool.

#user_name ⇒ String

The email address of the user.

Users\' email addresses are case-sensitive.

Returns:

  • (String) —

    The email address of the user.