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

Class: Aws::IAM::InstanceProfile

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes 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)


19
20
21
22
23
24
25
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.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_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: _+=,.@-

Returns:

  • (EmptyStructure)


257
258
259
260
261
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 257

def add_role(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = @client.add_role_to_instance_profile(options)
  resp.data
end

#arnString

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.

Returns:

  • (String)


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

def arn
  data[:arn]
end

#clientClient

Returns:



79
80
81
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 79

def client
  @client
end

#create_dateTime

The date when the instance profile was created.

Returns:

  • (Time)


72
73
74
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 72

def create_date
  data[:create_date]
end

#dataTypes::InstanceProfile

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

Returns:



99
100
101
102
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 99

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.



107
108
109
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 107

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance_profile.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


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

def delete(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = @client.delete_instance_profile(options)
  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.



114
115
116
117
118
119
120
121
122
123
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 114

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

#instance_profile_idString

The stable and unique string identifying the instance profile. 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/instance_profile.rb', line 54

def instance_profile_id
  data[:instance_profile_id]
end

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


89
90
91
92
93
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 89

def load
  resp = @client.get_instance_profile(instance_profile_name: @name)
  @data = resp.instance_profile
  self
end

#nameString Also known as: instance_profile_name

Returns:

  • (String)


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

def name
  @name
end

#pathString

The path to the instance profile. 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/instance_profile.rb', line 42

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: _+=,.@-

Returns:

  • (EmptyStructure)


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

def remove_role(options = {})
  options = options.merge(instance_profile_name: @name)
  resp = @client.remove_role_from_instance_profile(options)
  resp.data
end

#rolesRole::Collection

Returns:



301
302
303
304
305
306
307
308
309
310
311
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 301

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

#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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/instance_profile.rb', line 220

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) ⇒ 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:



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

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