Class: Aws::Wickr::Types::BatchCreateUserRequestItem

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

Overview

Contains the details for a single user to be created in a batch user creation request.

A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.

codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.

See Also:

Constant Summary collapse

SENSITIVE = 
[:first_name, :last_name]

Instance Attribute Summary collapse

Instance Attribute Details

#code_validation ⇒ Boolean

Indicates whether the user can be verified through a custom invite code.

Returns:

  • (Boolean) 


152
153
154
155
156
157
158
159
160
161
162
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 152

class BatchCreateUserRequestItem < Struct.new(
  :first_name,
  :last_name,
  :security_group_ids,
  :username,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#first_name ⇒ String

The first name of the user.

Returns:

  • (String) 


152
153
154
155
156
157
158
159
160
161
162
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 152

class BatchCreateUserRequestItem < Struct.new(
  :first_name,
  :last_name,
  :security_group_ids,
  :username,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#invite_code ⇒ String

A custom invite code for the user. If not provided, one will be generated automatically.

Returns:

  • (String) 


152
153
154
155
156
157
158
159
160
161
162
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 152

class BatchCreateUserRequestItem < Struct.new(
  :first_name,
  :last_name,
  :security_group_ids,
  :username,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#invite_code_ttl ⇒ Integer

The time-to-live for the invite code in days. After this period, the invite code will expire.

Returns:

  • (Integer) 


152
153
154
155
156
157
158
159
160
161
162
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 152

class BatchCreateUserRequestItem < Struct.new(
  :first_name,
  :last_name,
  :security_group_ids,
  :username,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#last_name ⇒ String

The last name of the user.

Returns:

  • (String) 


152
153
154
155
156
157
158
159
160
161
162
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 152

class BatchCreateUserRequestItem < Struct.new(
  :first_name,
  :last_name,
  :security_group_ids,
  :username,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

A list of security group IDs to which the user should be assigned.

Returns:

  • (Array<String>) 


152
153
154
155
156
157
158
159
160
161
162
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 152

class BatchCreateUserRequestItem < Struct.new(
  :first_name,
  :last_name,
  :security_group_ids,
  :username,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#username ⇒ String

The email address or username for the user. Must be unique within the network.

Returns:

  • (String) 


152
153
154
155
156
157
158
159
160
161
162
 
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 152

class BatchCreateUserRequestItem < Struct.new(
  :first_name,
  :last_name,
  :security_group_ids,
  :username,
  :invite_code,
  :invite_code_ttl,
  :code_validation)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end