Class: Aws::IAM::InstanceProfile

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-iam/instance_profile.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of InstanceProfile.

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ InstanceProfile

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# 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

Instance Method Details

#add_role(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :role_name (required, String) —

    The name of the role 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure) 


280
281
282
283
284
285
286
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 280

def add_role(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.add_role_to_instance_profile(options)
  end
  resp.data
end

#arn ⇒ String

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

Returns:

  • (String) 


69
70
71
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 69

def arn
  data[:arn]
end

#client ⇒ Client

Returns:



94
95
96
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 94

def client
  @client
end

#create_date ⇒ Time

The date when the instance profile was created.

Returns:

  • (Time) 


75
76
77
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 75

def create_date
  data[:create_date]
end

#data ⇒ Types::InstanceProfile

Returns the data for this Aws::IAM::InstanceProfile. Calls Client#get_instance_profile if #data_loaded? is ‘false`.

Returns:



116
117
118
119
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 116

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.



124
125
126
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 124

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance_profile.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


293
294
295
296
297
298
299
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 293

def delete(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_instance_profile(options)
  end
  resp.data
end

#exists?(options = {}) ⇒ Boolean

Returns ‘true` if the InstanceProfile exists.

Parameters:

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

    ({})

Returns:

  • (Boolean) —

    Returns ‘true` if the InstanceProfile exists.



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 131

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 ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


344
345
346
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 344

def identifiers
  { name: @name }
end

#instance_profile_id ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 57

def instance_profile_id
  data[:instance_profile_id]
end

#load ⇒ self Also known as: reload

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

instance_profile.reload.data

Returns:

  • (self) 


104
105
106
107
108
109
110
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 104

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_instance_profile(instance_profile_name: @name)
  end
  @data = resp.instance_profile
  self
end

#name ⇒ String Also known as: instance_profile_name

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 33

def name
  @name
end

#path ⇒ String

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

Returns:

  • (String) 


45
46
47
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 45

def path
  data[:path]
end

#remove_role(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :role_name (required, String) —

    The name of the role 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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure) 


319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 319

def remove_role(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.remove_role_from_instance_profile(options)
  end
  resp.data
end

#roles ⇒ Role::Collection

Returns:



330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 330

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 ⇒ Array<Types::Tag>

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

Returns:



87
88
89
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 87

def tags
  data[:tags]
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 241

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end

#wait_until_exists(options = {}, &block) ⇒ InstanceProfile

Parameters:

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

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 40
  • :delay (Float) — default: 1
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/aws-sdk-iam/instance_profile.rb', line 148

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?
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    waiter.wait(params.merge(instance_profile_name: @name))
  end
  InstanceProfile.new({
    name: @name,
    client: @client
  })
end