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
25
# 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)
  @waiter_block_warned = false
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 (through 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)


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

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 IAM User Guide.

Returns:

  • (String)


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

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)


253
254
255
256
257
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 253

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 parameter allows (through 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. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 465

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:



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

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 parameter allows (through 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. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Returns:



284
285
286
287
288
289
290
291
292
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 284

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)


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

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 (through 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.

    You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

    The regex pattern used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Returns:



336
337
338
339
340
341
342
343
344
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 336

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:



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

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.



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

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


351
352
353
354
355
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 351

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)


373
374
375
376
377
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 373

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 IAM User Guide.

Returns:

  • (String)


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

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)


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

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

#nameString Also known as: group_name

Returns:

  • (String)


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

def name
  @name
end

#pathString

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

Returns:

  • (String)


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

def path
  data[:path]
end

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

Examples:

Request syntax with placeholder values


group.policies()

Parameters:

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

    ({})

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 488

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:



509
510
511
512
513
514
515
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 509

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 (through 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)


397
398
399
400
401
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 397

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 parameter allows (through 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. In addition, it can contain any ASCII character from the ! (\u0021) through 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.

    IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Returns:



432
433
434
435
436
437
438
439
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 432

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:



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 522

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

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::IAM::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/group.rb', line 194

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end