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

Class: Aws::IAM::AssumeRolePolicy

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(role_name, options = {}) ⇒ AssumeRolePolicy #initialize(options = {}) ⇒ AssumeRolePolicy

Returns a new instance of AssumeRolePolicy

Overloads:

  • #initialize(role_name, options = {}) ⇒ AssumeRolePolicy

    Parameters:

    • role_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ AssumeRolePolicy

    Options Hash (options):

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


19
20
21
22
23
24
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/assume_role_policy.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @role_name = extract_role_name(args, options)
  @data = Aws::EmptyStructure.new
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#clientClient

Returns:



36
37
38
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/assume_role_policy.rb', line 36

def client
  @client
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.



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

def data_loaded?
  !!@data
end

#roleRole

Returns:



188
189
190
191
192
193
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/assume_role_policy.rb', line 188

def role
  Role.new(
    name: @role_name,
    client: @client
  )
end

#role_nameString

Returns:

  • (String)


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

def role_name
  @role_name
end

#update(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


assume_role_policy.update({
  policy_document: "policyDocumentType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_document (required, String)

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

    The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).

Returns:

  • (EmptyStructure)


179
180
181
182
183
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/assume_role_policy.rb', line 179

def update(options = {})
  options = options.merge(role_name: @role_name)
  resp = @client.update_assume_role_policy(options)
  resp.data
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/assume_role_policy.rb', line 139

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