class Aws::IAM::InstanceProfile

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/instance_profile.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_role(options = {}) click to toggle source

@example Request syntax with placeholder values

instance_profile.add_role({
  role_name: "roleNameType", # required
})

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

The name of the role 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/instance_profile.rb, line 274
def add_role(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = @client.add_role_to_instance_profile(options)
  resp.data
end
arn() click to toggle source

The Amazon Resource Name (ARN) specifying the instance profile. 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/instance_profile.rb, line 69
def arn
  data[:arn]
end
client() click to toggle source

@return [Client]

# File lib/aws-sdk-iam/instance_profile.rb, line 94
def client
  @client
end
create_date() click to toggle source

The date when the instance profile was created. @return [Time]

# File lib/aws-sdk-iam/instance_profile.rb, line 75
def create_date
  data[:create_date]
end
data() click to toggle source

@return [Types::InstanceProfile]

Returns the data for this {InstanceProfile}. Calls
{Client#get_instance_profile} if {#data_loaded?} is `false`.
# File lib/aws-sdk-iam/instance_profile.rb, line 114
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/instance_profile.rb, line 122
def data_loaded?
  !!@data
end
delete(options = {}) click to toggle source

@example Request syntax with placeholder values

instance_profile.delete()

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

# File lib/aws-sdk-iam/instance_profile.rb, line 285
def delete(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = @client.delete_instance_profile(options)
  resp.data
end
exists?(options = {}) click to toggle source

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

Returns `true` if the InstanceProfile exists.
# File lib/aws-sdk-iam/instance_profile.rb, line 129
def exists?(options = {})
  begin
    wait_until_exists(options.merge(max_attempts: 1))
    true
  rescue Aws::Waiters::Errors::UnexpectedError => e
    raise e.error
  rescue Aws::Waiters::Errors::WaiterFailed
    false
  end
end
identifiers() click to toggle source

@deprecated @api private

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

The stable and unique string identifying the instance profile. 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/instance_profile.rb, line 57
def instance_profile_id
  data[:instance_profile_id]
end
instance_profile_name()
Alias for: name
load() click to toggle source

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

instance_profile.reload.data

@return [self]

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

@return [String]

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

The path to the instance profile. 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/instance_profile.rb, line 45
def path
  data[:path]
end
reload()
Alias for: load
remove_role(options = {}) click to toggle source

@example Request syntax with placeholder values

instance_profile.remove_role({
  role_name: "roleNameType", # required
})

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

The name of the role 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/instance_profile.rb, line 309
def remove_role(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = @client.remove_role_from_instance_profile(options)
  resp.data
end
roles() click to toggle source

@return [Role::Collection]

# File lib/aws-sdk-iam/instance_profile.rb, line 318
def roles
  batch = []
  data[:roles].each do |d|
    batch << Role.new(
      name: d[:role_name],
      data: d,
      client: @client
    )
  end
  Role::Collection.new([batch], size: batch.size)
end
tags() click to toggle source

A list of tags that are attached to the instance profile. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html @return [Array<Types::Tag>]

# File lib/aws-sdk-iam/instance_profile.rb, line 87
def tags
  data[:tags]
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/instance_profile.rb, line 237
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
wait_until_exists(options = {}, &block) click to toggle source

@param [Hash] options ({}) @option options [Integer] :max_attempts (40) @option options [Float] :delay (1) @option options [Proc] :before_attempt @option options [Proc] :before_wait @return [InstanceProfile]

# File lib/aws-sdk-iam/instance_profile.rb, line 146
def wait_until_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::InstanceProfileExists.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  waiter.wait(params.merge(instance_profile_name: @name))
  InstanceProfile.new({
    name: @name,
    client: @client
  })
end

Private Instance Methods

extract_name(args, options) click to toggle source
# File lib/aws-sdk-iam/instance_profile.rb, line 339
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
separate_params_and_options(options) click to toggle source
# File lib/aws-sdk-iam/instance_profile.rb, line 360
def separate_params_and_options(options)
  opts = Set.new(
    [:client, :max_attempts, :delay, :before_attempt, :before_wait]
  )
  waiter_opts = {}
  waiter_params = {}
  options.each_pair do |key, value|
    if opts.include?(key)
      waiter_opts[key] = value
    else
      waiter_params[key] = value
    end
  end
  waiter_opts[:client] ||= @client
  [waiter_opts, waiter_params]
end
yield_waiter_and_warn(waiter) { |waiter| ... } click to toggle source
# File lib/aws-sdk-iam/instance_profile.rb, line 350
def yield_waiter_and_warn(waiter, &block)
  if !@waiter_block_warned
    msg = "pass options to configure the waiter; "\
          "yielding the waiter is deprecated"
    warn(msg)
    @waiter_block_warned = true
  end
  yield(waiter.waiter)
end