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

Class: Aws::IAM::VirtualMfaDevice

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

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

    Parameters:

    • serial_number (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

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

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#base_32_string_seedString (readonly)

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

Returns:

  • (String)

    The Base32 seed defined as specified in [RFC3548][1].

#enable_dateTime (readonly)

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

Returns:

  • (Time)

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

#qr_code_pngString (readonly)

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)

    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.

#serial_numberString (readonly)

Returns:

  • (String)

Instance Method Details

#deleteStruct

Deletes a virtual MFA device.

You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

Examples:

Request syntax example with placeholder values


virtualmfadevice.delete()

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#userUser?

Returns: