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)


98
99
100
101
102
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 98

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:



107
108
109
110
111
112
113
114
115
116
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/virtual_mfa_device.rb', line 107

def user
  if data.user.user_name
    User.new(
      name: data.user.user_name,
      client: @client
    )
  else
    nil
  end
end