Class: Aws::IAM::VirtualMfaDevice

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(serial_number, options = {}) ⇒ VirtualMfaDevice #initialize(options = {}) ⇒ VirtualMfaDevice

Returns a new instance of VirtualMfaDevice.

Overloads:

  • #initialize(serial_number, options = {}) ⇒ VirtualMfaDevice

    Parameters:

    • serial_number (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ VirtualMfaDevice

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @serial_number = extract_serial_number(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#base_32_string_seed ⇒ String

The base32 seed defined as specified in [RFC3548]. The ‘Base32StringSeed` is base32-encoded.

[1]: tools.ietf.org/html/rfc3548.txt

Returns:

  • (String) 


44
45
46
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 44

def base_32_string_seed
  data[:base_32_string_seed]
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#data ⇒ Types::VirtualMFADevice

Returns the data for this Aws::IAM::VirtualMfaDevice.

Returns:

Raises:

  • (NotImplementedError) —

    Raises when #data_loaded? is ‘false`.



95
96
97
98
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 95

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.



103
104
105
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 103

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


virtual_mfa_device.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


213
214
215
216
217
218
219
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 213

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

#enable_date ⇒ Time

The date and time on which the virtual MFA device was enabled.

Returns:

  • (Time) 


61
62
63
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 61

def enable_date
  data[:enable_date]
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. 


237
238
239
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 237

def identifiers
  { serial_number: @serial_number }
end

#load ⇒ Object Also known as: reload

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.

Raises:

  • (NotImplementedError) 


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

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#qr_code_png ⇒ String

A QR code PNG image that encodes ‘otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String` where `$virtualMFADeviceName` is one of the create call arguments. `AccountName` is the user name if set (otherwise, the account ID otherwise), and `Base32String` is the seed in base32 format. The `Base32String` value is base64-encoded.

Returns:

  • (String) 


55
56
57
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 55

def qr_code_png
  data[:qr_code_png]
end

#serial_number ⇒ String

Returns:

  • (String) 


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

def serial_number
  @serial_number
end

#tags ⇒ Array<Types::Tag>

A list of tags that are attached to the virtual MFA device. 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:



73
74
75
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 73

def tags
  data[:tags]
end

#user ⇒ User?

Returns:



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 224

def user
  if data[:user][:user_name]
    User.new(
      name: data[:user][:user_name],
      client: @client
    )
  else
    nil
  end
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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 187

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