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

Class: Aws::IAM::Group

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Group #initialize(options = {}) ⇒ Group

Returns a new instance of Group

Overloads:

  • #initialize(name, options = {}) ⇒ Group

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Group

    Options Hash (options):

    • :name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#add_user(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group.add_user({
  user_name: "existingUserNameType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :user_name (required, String)

    The name of the user to add.

    This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Returns:

  • (EmptyStructure)


135
136
137
138
139
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 135

def add_user(options = {})
  options = options.merge(group_name: @name)
  resp = @client.add_user_to_group(options)
  resp.data
end

#arnString

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


65
66
67
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 65

def arn
  data.arn
end

#attach_policy(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group.attach_policy({
  policy_arn: "arnType", # required
})

Parameters:

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

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


157
158
159
160
161
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 157

def attach_policy(options = {})
  options = options.merge(group_name: @name)
  resp = @client.attach_group_policy(options)
  resp.data
end

#attached_policies(options = {}) ⇒ Policy::Collection

Examples:

Request syntax with placeholder values


attached_policies = group.attached_policies({
  path_prefix: "policyPathType",
})

Parameters:

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

    ({})

Options Hash (options):

  • :path_prefix (String)

    The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

    This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 365

def attached_policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(group_name: @name)
    resp = @client.list_attached_group_policies(options)
    resp.each_page do |page|
      batch = []
      page.data.attached_policies.each do |a|
        batch << Policy.new(
          arn: a.policy_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Policy::Collection.new(batches)
end

#clientClient

Returns:



83
84
85
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 83

def client
  @client
end

#create(options = {}) ⇒ Group

Examples:

Request syntax with placeholder values


group = group.create({
  path: "pathType",
})

Parameters:

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

    ({})

Options Hash (options):

  • :path (String)

    The path to the group. For more information about paths, see IAM Identifiers in the IAM User Guide.

    This parameter is optional. If it is not included, it defaults to a slash (/).

    This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:



188
189
190
191
192
193
194
195
196
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 188

def create(options = {})
  options = options.merge(group_name: @name)
  resp = @client.create_group(options)
  Group.new(
    name: options[:group_name],
    data: resp.data.group,
    client: @client
  )
end

#create_dateTime

The date and time, in ISO 8601 date-time format, when the group was created.

Returns:

  • (Time)


76
77
78
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 76

def create_date
  data.create_date
end

#create_policy(options = {}) ⇒ GroupPolicy

Examples:

Request syntax with placeholder values


grouppolicy = group.create_policy({
  policy_name: "policyNameType", # required
  policy_document: "policyDocumentType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_name (required, String)

    The name of the policy document.

    This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

  • :policy_document (required, String)

    The policy document.

    The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).

Returns:



231
232
233
234
235
236
237
238
239
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 231

def create_policy(options = {})
  options = options.merge(group_name: @name)
  resp = @client.put_group_policy(options)
  GroupPolicy.new(
    group_name: @name,
    name: options[:policy_name],
    client: @client
  )
end

#dataTypes::Group

Returns the data for this Aws::IAM::Group. Calls Client#get_group if #data_loaded? is false.

Returns:



103
104
105
106
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 103

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



111
112
113
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 111

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


246
247
248
249
250
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 246

def delete(options = {})
  options = options.merge(group_name: @name)
  resp = @client.delete_group(options)
  resp.data
end

#detach_policy(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group.detach_policy({
  policy_arn: "arnType", # required
})

Parameters:

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

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


268
269
270
271
272
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 268

def detach_policy(options = {})
  options = options.merge(group_name: @name)
  resp = @client.detach_group_policy(options)
  resp.data
end

#group_idString

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


53
54
55
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 53

def group_id
  data.group_id
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::IAM::Group. Returns self making it possible to chain methods.

group.reload.data

Returns:

  • (self)


93
94
95
96
97
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 93

def load
  resp = @client.get_group(group_name: @name)
  @data = resp.group
  self
end

#nameString Also known as: group_name

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 29

def name
  @name
end

#pathString

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 41

def path
  data.path
end

#policies(options = {}) ⇒ GroupPolicy::Collection

Examples:

Request syntax with placeholder values


group.policies()

Parameters:

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

    ({})

Returns:



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 388

def policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(group_name: @name)
    resp = @client.list_group_policies(options)
    resp.each_page do |page|
      batch = []
      page.data.policy_names.each do |p|
        batch << GroupPolicy.new(
          group_name: @name,
          name: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  GroupPolicy::Collection.new(batches)
end

#policy(name) ⇒ GroupPolicy

Parameters:

  • name (String)

Returns:



409
410
411
412
413
414
415
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 409

def policy(name)
  GroupPolicy.new(
    group_name: @name,
    name: name,
    client: @client
  )
end

#remove_user(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group.remove_user({
  user_name: "existingUserNameType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :user_name (required, String)

    The name of the user to remove.

    This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Returns:

  • (EmptyStructure)


292
293
294
295
296
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 292

def remove_user(options = {})
  options = options.merge(group_name: @name)
  resp = @client.remove_user_from_group(options)
  resp.data
end

#update(options = {}) ⇒ Group

Examples:

Request syntax with placeholder values


group = group.update({
  new_path: "pathType",
  new_group_name: "groupNameType",
})

Parameters:

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

    ({})

Options Hash (options):

  • :new_path (String)

    New path for the IAM group. Only include this if changing the group's path.

    This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

  • :new_group_name (String)

    New name for the IAM group. Only include this if changing the group's name.

    This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Returns:



332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 332

def update(options = {})
  options = options.merge(group_name: @name)
  resp = @client.update_group(options)
  Group.new(
    name: options[:new_group_name],
    client: @client
  )
end

#users(options = {}) ⇒ User::Collection

Examples:

Request syntax with placeholder values


group.users()

Parameters:

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

    ({})

Returns:



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 422

def users(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(group_name: @name)
    resp = @client.get_group(options)
    resp.each_page do |page|
      batch = []
      page.data.users.each do |u|
        batch << User.new(
          name: u.user_name,
          data: u,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  User::Collection.new(batches)
end