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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Describes a user in the user pool.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the user.

Returns:

  • (String)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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

#authentication_typeString

The authentication type for the user.

Returns:

  • (String)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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

#created_timeTime

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

Returns:

  • (Time)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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

#enabledBoolean

Specifies whether the user in the user pool is enabled.

Returns:

  • (Boolean)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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

#first_nameString

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

Returns:

  • (String)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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

#last_nameString

The last name, or surname, of the user.

Returns:

  • (String)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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

#statusString

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)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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

#user_nameString

The email address of the user.

Users' email addresses are case-sensitive.

Returns:

  • (String)


3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3698

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