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

Class: Aws::IAM::VirtualMfaDevice

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

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


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

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)
end

Instance Method Details

#base_32_string_seedString

The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.

Returns:

  • (String)


40
41
42
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 40

def base_32_string_seed
  data[:base_32_string_seed]
end

#clientClient

Returns:



64
65
66
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 64

def client
  @client
end

#dataTypes::VirtualMFADevice

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

Returns:

Raises:



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

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.



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

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)


193
194
195
196
197
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 193

def delete(options = {})
  options = options.merge(serial_number: @serial_number)
  resp = @client.delete_virtual_mfa_device(options)
  resp.data
end

#enable_dateTime

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

Returns:

  • (Time)


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

def enable_date
  data[:enable_date]
end

#qr_code_pngString

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)


51
52
53
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 51

def qr_code_png
  data[:qr_code_png]
end

#serial_numberString

Returns:

  • (String)


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

def serial_number
  @serial_number
end

#userUser?

Returns:



202
203
204
205
206
207
208
209
210
211
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 202

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 169

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