class Aws::IAM::VirtualMfaDevice
Public Class Methods
@overload def initialize(serial_number
, options = {})
@param [String] serial_number @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :serial_number @option options [Client] :client
# 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
Public Instance Methods
The base32 seed defined as specified in [RFC3548]. The `Base32StringSeed` is base64-encoded.
[1]: tools.ietf.org/html/rfc3548.txt @return [String]
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 44 def base_32_string_seed data[:base_32_string_seed] end
@return [Client]
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 80 def client @client end
@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::VirtualMFADevice]
Returns the data for this {VirtualMfaDevice}.
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 95 def data load unless @data @data end
@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/virtual_mfa_device.rb, line 103 def data_loaded? !!@data end
@example Request syntax with placeholder values
virtual_mfa_device.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 211 def delete(options = {}) options = options.merge(serial_number: @serial_number) resp = @client.delete_virtual_mfa_device(options) resp.data end
The date and time on which the virtual MFA device was enabled. @return [Time]
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 61 def enable_date data[:enable_date] end
@deprecated @api private
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 233 def identifiers { serial_number: @serial_number } end
@raise [NotImplementedError] @api private
# 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
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. @return [String]
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 55 def qr_code_png data[:qr_code_png] end
@return [String]
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 33 def serial_number @serial_number end
@return [User, nil]
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 220 def user if data[:user][:user_name] User.new( name: data[:user][:user_name], client: @client ) else nil end end
@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/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::Waiters::Waiter.new(options).wait({}) end
Private Instance Methods
# File lib/aws-sdk-iam/virtual_mfa_device.rb, line 240 def extract_serial_number(args, options) value = args[0] || 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