class Aws::IAM::MfaDevice

Public Class Methods

new(*args) click to toggle source

@overload def initialize(user_name, serial_number, options = {})

@param [String] user_name
@param [String] serial_number
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :user_name
@option options [required, String] :serial_number
@option options [Client] :client
# File lib/aws-sdk-iam/mfa_device.rb, line 24
def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @user_name = extract_user_name(args, options)
  @serial_number = extract_serial_number(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Public Instance Methods

associate(options = {}) click to toggle source

@example Request syntax with placeholder values

mfa_device.associate({
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
})

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

An authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication
codes. If you generate the codes and then wait too long to submit the
request, the MFA device successfully associates with the user but the
MFA device becomes out of sync. This happens because time-based
one-time passwords (TOTP) expire after a short period of time. If this
happens, you can [resync the device][1].

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

@option options [required, String] :authentication_code_2

A subsequent authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication
codes. If you generate the codes and then wait too long to submit the
request, the MFA device successfully associates with the user but the
MFA device becomes out of sync. This happens because time-based
one-time passwords (TOTP) expire after a short period of time. If this
happens, you can [resync the device][1].

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

@return [EmptyStructure]

# File lib/aws-sdk-iam/mfa_device.rb, line 218
def associate(options = {})
  options = options.merge(
    user_name: @user_name,
    serial_number: @serial_number
  )
  resp = @client.enable_mfa_device(options)
  resp.data
end
client() click to toggle source

@return [Client]

# File lib/aws-sdk-iam/mfa_device.rb, line 54
def client
  @client
end
data() click to toggle source

@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::MFADevice]

Returns the data for this {MfaDevice}.
# File lib/aws-sdk-iam/mfa_device.rb, line 69
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/mfa_device.rb, line 77
def data_loaded?
  !!@data
end
disassociate(options = {}) click to toggle source

@example Request syntax with placeholder values

mfa_device.disassociate()

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

# File lib/aws-sdk-iam/mfa_device.rb, line 232
def disassociate(options = {})
  options = options.merge(
    user_name: @user_name,
    serial_number: @serial_number
  )
  resp = @client.deactivate_mfa_device(options)
  resp.data
end
enable_date() click to toggle source

The date when the MFA device was enabled for the user. @return [Time]

# File lib/aws-sdk-iam/mfa_device.rb, line 47
def enable_date
  data[:enable_date]
end
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-iam/mfa_device.rb, line 278
def identifiers
  {
    user_name: @user_name,
    serial_number: @serial_number
  }
end
load() click to toggle source

@raise [NotImplementedError] @api private

# File lib/aws-sdk-iam/mfa_device.rb, line 60
def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end
Also aliased as: reload
reload()
Alias for: load
resync(options = {}) click to toggle source

@example Request syntax with placeholder values

mfa_device.resync({
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
})

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

An authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

@option options [required, String] :authentication_code_2

A subsequent authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

@return [EmptyStructure]

# File lib/aws-sdk-iam/mfa_device.rb, line 257
def resync(options = {})
  options = options.merge(
    user_name: @user_name,
    serial_number: @serial_number
  )
  resp = @client.resync_mfa_device(options)
  resp.data
end
serial_number() click to toggle source

@return [String]

# File lib/aws-sdk-iam/mfa_device.rb, line 41
def serial_number
  @serial_number
end
user() click to toggle source

@return [User]

# File lib/aws-sdk-iam/mfa_device.rb, line 269
def user
  User.new(
    name: @user_name,
    client: @client
  )
end
user_name() click to toggle source

@return [String]

# File lib/aws-sdk-iam/mfa_device.rb, line 36
def user_name
  @user_name
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/mfa_device.rb, line 161
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

Private Instance Methods

extract_serial_number(args, options) click to toggle source
# File lib/aws-sdk-iam/mfa_device.rb, line 299
def extract_serial_number(args, options)
  value = args[1] || options.delete(:serial_number)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :serial_number"
  else
    msg = "expected :serial_number to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end
extract_user_name(args, options) click to toggle source
# File lib/aws-sdk-iam/mfa_device.rb, line 288
def extract_user_name(args, options)
  value = args[0] || options.delete(:user_name)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :user_name"
  else
    msg = "expected :user_name to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end