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

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

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::CreateUserRequest

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #authentication_type ⇒ String

  The authentication type for the user.

• #first_name ⇒ String

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

• #last_name ⇒ String

  The last name, or surname, of the user.

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

• #user_name ⇒ String

  The email address of the user.

Instance Attribute Details

#authentication_type ⇒ String

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

Returns:

• (String)

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

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)

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

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)

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

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.

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)

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

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.

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)

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

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