Class: Aws::IAM::VirtualMfaDevice

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

Overview

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IAM/VirtualMfaDevice.html

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) 


13
14
15
 
# File 'sig/virtual_mfa_device.rbs', line 13

def initialize: (String serial_number, Hash[Symbol, untyped] options) -> void
| (serial_number: String, ?client: Client) -> void
| (Hash[Symbol, untyped] args) -> void

Instance Method Details

#base_32_string_seed ⇒ String

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

Returns:

  • (String) 


21
 
# File 'sig/virtual_mfa_device.rbs', line 21

def base_32_string_seed: () -> ::String

#client ⇒ Client

Returns:



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

def client: () -> Client

#data ⇒ Types::VirtualMFADevice

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

Returns:

Raises:



36
 
# File 'sig/virtual_mfa_device.rbs', line 36

def data: () -> Types::VirtualMFADevice

#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.



39
 
# File 'sig/virtual_mfa_device.rbs', line 39

def data_loaded?: () -> bool

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


virtual_mfa_device.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


43
 
# File 'sig/virtual_mfa_device.rbs', line 43

def delete: (

#enable_date ⇒ Time

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

Returns:

  • (Time) 


27
 
# File 'sig/virtual_mfa_device.rbs', line 27

def enable_date: () -> ::Time

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


24
 
# File 'sig/virtual_mfa_device.rbs', line 24

def qr_code_png: () -> ::String

#serial_number ⇒ String

Returns:

  • (String) 


18
 
# File 'sig/virtual_mfa_device.rbs', line 18

def serial_number: () -> String

#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.

Returns:



30
 
# File 'sig/virtual_mfa_device.rbs', line 30

def tags: () -> ::Array[Types::Tag]

#user ⇒ User?

Returns:



48
 
# File 'sig/virtual_mfa_device.rbs', line 48

def user: () -> User?

#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