Class: AWS::IAM::GroupUserCollection

Inherits:
Object
  • Object
show all
Defined in:
lib/aws/iam/group_user_collection.rb

Overview

A collection that provides access to IAM users belonging to a particular group.

group = AWS::IAM.new.groups.first
users = group.users
users.each { |u| puts u.name }

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#group ⇒ Object (readonly) 



31
32
33
 
# File 'lib/aws/iam/group_user_collection.rb', line 31

def group
  @group
end

Instance Method Details

#add(user) ⇒ nil

Adds a user to the group.

Parameters:

  • user (User) —

    The user to add.

Returns:

  • (nil) 


43
44
45
46
47
 
# File 'lib/aws/iam/group_user_collection.rb', line 43

def add(user)
  client.add_user_to_group(:group_name => group.name,
                           :user_name => user.name)
  nil
end

#clear ⇒ nil

Removes all users from this group.

Returns:

  • (nil) 


61
62
63
64
65
 
# File 'lib/aws/iam/group_user_collection.rb', line 61

def clear
  each do |user|
    remove(user)
  end
end

#each(options = {}) {|user| ... } ⇒ nil

Yields once for each user in the group.

Parameters:

  • options (Hash) (defaults to: {})

Yield Parameters:

Returns:

  • (nil) 


72
73
74
 
# File 'lib/aws/iam/group_user_collection.rb', line 72

def each(options = {}, &block)
  super(options.merge(:group_name => group.name), &block)
end

#remove(user) ⇒ nil

Remove a user from the group.

Parameters:

  • user (User) —

    The user to remove.

Returns:

  • (nil) 


53
54
55
56
57
 
# File 'lib/aws/iam/group_user_collection.rb', line 53

def remove(user)
  client.remove_user_from_group(:group_name => group.name,
                                :user_name => user.name)
  nil
end