class Aws::IAM::Group

Public Class Methods

new(*args) click to toggle source

@overload def initialize(name, options = {})

@param [String] name
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :name
@option options [Client] :client
# File lib/aws-sdk-iam/group.rb, line 22
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

Public Instance Methods

add_user(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [required, String] :user_name

The name of the user to add.

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

[1]: http://wikipedia.org/wiki/regex

@return [EmptyStructure]

# File lib/aws-sdk-iam/group.rb, line 236
def add_user(options = {})
  options = options.merge(group_name: @name)
  resp = @client.add_user_to_group(options)
  resp.data
end
arn() click to toggle source

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*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html @return [String]

# File lib/aws-sdk-iam/group.rb, line 69
def arn
  data[:arn]
end
attach_policy(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [required, String] :policy_arn

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see [Amazon Resource Names (ARNs)][1]
in the *Amazon Web Services General Reference*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

@return [EmptyStructure]

# File lib/aws-sdk-iam/group.rb, line 258
def attach_policy(options = {})
  options = options.merge(group_name: @name)
  resp = @client.attach_group_policy(options)
  resp.data
end
attached_policies(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [String] :path_prefix

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][1]) 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.

[1]: http://wikipedia.org/wiki/regex

@return [Policy::Collection]

# File lib/aws-sdk-iam/group.rb, line 470
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
client() click to toggle source

@return [Client]

# File lib/aws-sdk-iam/group.rb, line 87
def client
  @client
end
create(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [String] :path

The path to the group. For more information about paths, see [IAM
identifiers][1] 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][2]) 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.

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
[2]: http://wikipedia.org/wiki/regex

@return [Group]

# File lib/aws-sdk-iam/group.rb, line 289
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_date() click to toggle source

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

[1]: www.iso.org/iso/iso8601 @return [Time]

# File lib/aws-sdk-iam/group.rb, line 80
def create_date
  data[:create_date]
end
create_policy(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [required, String] :policy_name

The name of the policy document.

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

[1]: http://wikipedia.org/wiki/regex

@option options [required, String] :policy_document

The policy document.

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

The [regex pattern][1] 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`)

[1]: http://wikipedia.org/wiki/regex

@return [GroupPolicy]

# File lib/aws-sdk-iam/group.rb, line 341
def create_policy(options = {})
  options = options.merge(group_name: @name)
  @client.put_group_policy(options)
  GroupPolicy.new(
    group_name: @name,
    name: options[:policy_name],
    client: @client
  )
end
data() click to toggle source

@return [Types::Group]

Returns the data for this {Group}. Calls
{Client#get_group} if {#data_loaded?} is `false`.
# File lib/aws-sdk-iam/group.rb, line 107
def data
  load unless @data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-iam/group.rb, line 115
def data_loaded?
  !!@data
end
delete(options = {}) click to toggle source

@example Request syntax with placeholder values

group.delete()

@param [Hash] options ({}) @return [EmptyStructure]

# File lib/aws-sdk-iam/group.rb, line 356
def delete(options = {})
  options = options.merge(group_name: @name)
  resp = @client.delete_group(options)
  resp.data
end
detach_policy(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [required, String] :policy_arn

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see [Amazon Resource Names (ARNs)][1]
in the *Amazon Web Services General Reference*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

@return [EmptyStructure]

# File lib/aws-sdk-iam/group.rb, line 378
def detach_policy(options = {})
  options = options.merge(group_name: @name)
  resp = @client.detach_group_policy(options)
  resp.data
end
group_id() click to toggle source

The stable and unique string identifying the group. For more information about IDs, see [IAM identifiers] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html @return [String]

# File lib/aws-sdk-iam/group.rb, line 57
def group_id
  data[:group_id]
end
group_name()
Alias for: name
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-iam/group.rb, line 548
def identifiers
  { name: @name }
end
load() click to toggle source

Loads, or reloads {#data} for the current {Group}. Returns `self` making it possible to chain methods.

group.reload.data

@return [self]

# File lib/aws-sdk-iam/group.rb, line 97
def load
  resp = @client.get_group(group_name: @name)
  @data = resp.group
  self
end
Also aliased as: reload
name() click to toggle source

@return [String]

# File lib/aws-sdk-iam/group.rb, line 33
def name
  @name
end
Also aliased as: group_name
path() click to toggle source

The path to the group. For more information about paths, see [IAM identifiers] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html @return [String]

# File lib/aws-sdk-iam/group.rb, line 45
def path
  data[:path]
end
policies(options = {}) click to toggle source

@example Request syntax with placeholder values

group.policies()

@param [Hash] options ({}) @return [GroupPolicy::Collection]

# File lib/aws-sdk-iam/group.rb, line 493
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) click to toggle source

@param [String] name @return [GroupPolicy]

# File lib/aws-sdk-iam/group.rb, line 514
def policy(name)
  GroupPolicy.new(
    group_name: @name,
    name: name,
    client: @client
  )
end
reload()
Alias for: load
remove_user(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [required, String] :user_name

The name of the user to remove.

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

[1]: http://wikipedia.org/wiki/regex

@return [EmptyStructure]

# File lib/aws-sdk-iam/group.rb, line 402
def remove_user(options = {})
  options = options.merge(group_name: @name)
  resp = @client.remove_user_from_group(options)
  resp.data
end
update(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [String] :new_path

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

This parameter allows (through its [regex pattern][1]) 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.

[1]: http://wikipedia.org/wiki/regex

@option options [String] :new_group_name

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".

@return [Group]

# File lib/aws-sdk-iam/group.rb, line 437
def update(options = {})
  options = options.merge(group_name: @name)
  @client.update_group(options)
  Group.new(
    name: options[:new_group_name],
    client: @client
  )
end
users(options = {}) click to toggle source

@example Request syntax with placeholder values

group.users()

@param [Hash] options ({}) @return [User::Collection]

# File lib/aws-sdk-iam/group.rb, line 527
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) click to toggle source

@deprecated Use [Aws::IAM::Client] wait_until instead

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

@note The waiting operation is performed on a copy. The original resource

remains unchanged.

## 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) do |instance|
  instance.state.name == 'running'
end

## 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

@yieldparam [Resource] resource to be used in the waiting condition.

@raise [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.

@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is

encountered while polling for a resource that is not expected.

@raise [NotImplementedError] Raised when the resource does not

@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful

# File lib/aws-sdk-iam/group.rb, line 199
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

Private Instance Methods

extract_name(args, options) click to toggle source
# File lib/aws-sdk-iam/group.rb, line 555
def extract_name(args, options)
  value = args[0] || options.delete(:name)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :name"
  else
    msg = "expected :name to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end