Class: Aws::AppStream::Types::CreateUserRequest

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

Overview

Note:

When making an API call, you may pass CreateUserRequest data as a hash:

{
  user_name: "Username", # required
  message_action: "SUPPRESS", # accepts SUPPRESS, RESEND
  first_name: "UserAttributeValue",
  last_name: "UserAttributeValue",
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_type ⇒ String

The authentication type for the user. You must specify USERPOOL.

Returns:

  • (String) 


928
929
930
931
932
933
934
935
 
# File 'lib/aws-sdk-appstream/types.rb', line 928

class CreateUserRequest < Struct.new(
  :user_name,
  :message_action,
  :first_name,
  :last_name,
  :authentication_type)
  include Aws::Structure
end

#first_name ⇒ String

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

Returns:

  • (String) 


928
929
930
931
932
933
934
935
 
# File 'lib/aws-sdk-appstream/types.rb', line 928

class CreateUserRequest < Struct.new(
  :user_name,
  :message_action,
  :first_name,
  :last_name,
  :authentication_type)
  include Aws::Structure
end

#last_name ⇒ String

The last name, or surname, of the user.

Returns:

  • (String) 


928
929
930
931
932
933
934
935
 
# File 'lib/aws-sdk-appstream/types.rb', line 928

class CreateUserRequest < Struct.new(
  :user_name,
  :message_action,
  :first_name,
  :last_name,
  :authentication_type)
  include Aws::Structure
end

#message_action ⇒ String

The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

<note markdown=“1”> The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

</note>

Returns:

  • (String) 


928
929
930
931
932
933
934
935
 
# File 'lib/aws-sdk-appstream/types.rb', line 928

class CreateUserRequest < Struct.new(
  :user_name,
  :message_action,
  :first_name,
  :last_name,
  :authentication_type)
  include Aws::Structure
end

#user_name ⇒ String

The email address of the user.

Returns:

  • (String) 


928
929
930
931
932
933
934
935
 
# File 'lib/aws-sdk-appstream/types.rb', line 928

class CreateUserRequest < Struct.new(
  :user_name,
  :message_action,
  :first_name,
  :last_name,
  :authentication_type)
  include Aws::Structure
end