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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/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
}

Constant Summary collapse

SENSITIVE =
[:user_name, :first_name, :last_name]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_typeString

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

Returns:

  • (String)


1369
1370
1371
1372
1373
1374
1375
1376
1377
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1369

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

#first_nameString

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

Returns:

  • (String)


1369
1370
1371
1372
1373
1374
1375
1376
1377
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1369

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

#last_nameString

The last name, or surname, of the user.

Returns:

  • (String)


1369
1370
1371
1372
1373
1374
1375
1376
1377
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1369

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

#message_actionString

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.

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.

Returns:

  • (String)


1369
1370
1371
1372
1373
1374
1375
1376
1377
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1369

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

#user_nameString

The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.

Returns:

  • (String)


1369
1370
1371
1372
1373
1374
1375
1376
1377
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1369

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