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
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
-
#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.
1843 1844 1845 1846 1847 1848 1849 1850 1851 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1843 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_name ⇒ String
The first name, or given name, of the user.
1843 1844 1845 1846 1847 1848 1849 1850 1851 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1843 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_name ⇒ String
The last name, or surname, of the user.
1843 1844 1845 1846 1847 1848 1849 1850 1851 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1843 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_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.
1843 1844 1845 1846 1847 1848 1849 1850 1851 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1843 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_name ⇒ String
The email address of the user.
1843 1844 1845 1846 1847 1848 1849 1850 1851 |
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1843 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 |