Class: Aws::IAM::Role

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Role.

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Role

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.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

#arn ⇒ String

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.

Returns:

  • (String) 


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

def arn
  data[:arn]
end

#assume_role_policy ⇒ AssumeRolePolicy

Returns:



360
361
362
363
364
365
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 360

def assume_role_policy
  AssumeRolePolicy.new(
    role_name: @name,
    client: @client
  )
end

#assume_role_policy_document ⇒ String

The policy that grants an entity permission to assume the role.

Returns:

  • (String) 


86
87
88
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 86

def assume_role_policy_document
  data[:assume_role_policy_document]
end

#attach_policy(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :policy_arn (required, String) —

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

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

Returns:

  • (EmptyStructure) 


312
313
314
315
316
317
318
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 312

def attach_policy(options = {})
  options = options.merge(role_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.attach_role_policy(options)
  end
  resp.data
end

#attached_policies(options = {}) ⇒ Policy::Collection

Examples:

Request syntax with placeholder values


attached_policies = role.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:



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 389

def attached_policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(role_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_attached_role_policies(options)
    end
    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 ⇒ Client

Returns:



161
162
163
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 161

def client
  @client
end

#create_date ⇒ Time

The date and time, in ISO 8601 date-time format, when the role was created.

Returns:

  • (Time) 


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

def create_date
  data[:create_date]
end

#data ⇒ Types::Role

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

Returns:



183
184
185
186
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 183

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.



191
192
193
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 191

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


role.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


325
326
327
328
329
330
331
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 325

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

#description ⇒ String

A description of the role that you provide.

Returns:

  • (String) 


92
93
94
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 92

def description
  data[:description]
end

#detach_policy(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :policy_arn (required, String) —

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

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

Returns:

  • (EmptyStructure) 


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

def detach_policy(options = {})
  options = options.merge(role_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.detach_role_policy(options)
  end
  resp.data
end

#instance_profiles(options = {}) ⇒ InstanceProfile::Collection

Examples:

Request syntax with placeholder values


role.instance_profiles()

Parameters:

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

    ({})

Returns:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 414

def instance_profiles(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(role_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_instance_profiles_for_role(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.instance_profiles.each do |i|
        batch << InstanceProfile.new(
          name: i.instance_profile_name,
          data: i,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  InstanceProfile::Collection.new(batches)
end

#load ⇒ self Also known as: reload

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

role.reload.data

Returns:

  • (self) 


171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 171

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_role(role_name: @name)
  end
  @data = resp.role
  self
end

#max_session_duration ⇒ Integer

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

Returns:

  • (Integer) 


101
102
103
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 101

def max_session_duration
  data[:max_session_duration]
end

#name ⇒ String Also known as: role_name

Returns:

  • (String) 


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

def name
  @name
end

#path ⇒ String

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

Returns:

  • (String) 


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

def path
  data[:path]
end

#permissions_boundary ⇒ Types::AttachedPermissionsBoundary

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

Returns:



115
116
117
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 115

def permissions_boundary
  data[:permissions_boundary]
end

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

Examples:

Request syntax with placeholder values


role.policies()

Parameters:

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

    ({})

Returns:



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 440

def policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(role_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_role_policies(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.policy_names.each do |p|
        batch << RolePolicy.new(
          role_name: @name,
          name: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  RolePolicy::Collection.new(batches)
end

#policy(name) ⇒ RolePolicy

Parameters:

  • name (String)

Returns:



463
464
465
466
467
468
469
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 463

def policy(name)
  RolePolicy.new(
    role_name: @name,
    name: name,
    client: @client
  )
end

#role_id ⇒ String

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

Returns:

  • (String) 


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

def role_id
  data[:role_id]
end

#role_last_used ⇒ Types::RoleLastUsed

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

Returns:



142
143
144
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 142

def role_last_used
  data[:role_last_used]
end

#source_role_template ⇒ Types::SourceRoleTemplate

Contains information about the role template that this role was created from. This member is present only for roles created with AcquireRole.

Returns:



154
155
156
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 154

def source_role_template
  data[:source_role_template]
end

#tags ⇒ Array<Types::Tag>

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Returns:



126
127
128
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 126

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/role.rb', line 275

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