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

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::User

Defined in:

gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Describes a user in the user pool.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:user_name, :first_name, :last_name]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the user.

• #authentication_type ⇒ String

  The authentication type for the user.

• #created_time ⇒ 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.

• #first_name ⇒ String

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

• #last_name ⇒ String

  The last name, or surname, of the user.

• #status ⇒ String

  The status of the user in the user pool.

• #user_name ⇒ String

  The email address of the user.

Instance Attribute Details

#arn ⇒ String

The ARN of the user.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end

#authentication_type ⇒ String

The authentication type for the user.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end

#created_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end

#enabled ⇒ Boolean

Specifies whether the user in the user pool is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end

#first_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end

#last_name ⇒ String

The last name, or surname, of the user.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end

#user_name ⇒ String

The email address of the user.

Users' email addresses are case-sensitive.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5597

class User < Struct.new(
  :arn,
  :user_name,
  :enabled,
  :status,
  :first_name,
  :last_name,
  :created_time,
  :authentication_type)
  SENSITIVE = [:user_name, :first_name, :last_name]
  include Aws::Structure
end