Class: Aws::CognitoIdentityProvider::Types::AdminAddUserToGroupRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#group_name ⇒ String

The name of the group that you want to add your user to.

Returns:

  • (String) 


243
244
245
246
247
248
249
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 243

class AdminAddUserToGroupRequest < Struct.new(
  :user_pool_id,
  :username,
  :group_name)
  SENSITIVE = [:username]
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool that contains the group that you want to add the user to.

Returns:

  • (String) 


243
244
245
246
247
248
249
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 243

class AdminAddUserToGroupRequest < Struct.new(
  :user_pool_id,
  :username,
  :group_name)
  SENSITIVE = [:username]
  include Aws::Structure
end

#username ⇒ String

The username of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

  • (String) 


243
244
245
246
247
248
249
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 243

class AdminAddUserToGroupRequest < Struct.new(
  :user_pool_id,
  :username,
  :group_name)
  SENSITIVE = [:username]
  include Aws::Structure
end