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

Class: Aws::IAM::MfaDevice

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_name, serial_number, options = {}) ⇒ MfaDevice #initialize(options = {}) ⇒ MfaDevice

Returns a new instance of MfaDevice

Overloads:

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

    Parameters:

    • user_name (String)
    • serial_number (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ MfaDevice

    Options Hash (options):

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


21
22
23
24
25
26
27
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 21

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @user_name = extract_user_name(args, options)
  @serial_number = extract_serial_number(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#associate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


mfa_device.associate({
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :authentication_code_1 (required, String)

    An authentication code emitted by the device.

    The format for this parameter is a string of 6 digits.

    Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

  • :authentication_code_2 (required, String)

    A subsequent authentication code emitted by the device.

    The format for this parameter is a string of 6 digits.

    Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

Returns:

  • (EmptyStructure)


117
118
119
120
121
122
123
124
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 117

def associate(options = {})
  options = options.merge(
    user_name: @user_name,
    serial_number: @serial_number
  )
  resp = @client.enable_mfa_device(options)
  resp.data
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::MFADevice

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

Returns:

Raises:



65
66
67
68
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 65

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.



73
74
75
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 73

def data_loaded?
  !!@data
end

#disassociate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


mfa_device.disassociate()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


131
132
133
134
135
136
137
138
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 131

def disassociate(options = {})
  options = options.merge(
    user_name: @user_name,
    serial_number: @serial_number
  )
  resp = @client.deactivate_mfa_device(options)
  resp.data
end

#enable_dateTime

The date when the MFA device was enabled for the user.

Returns:

  • (Time)


43
44
45
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 43

def enable_date
  data.enable_date
end

#resync(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


mfa_device.resync({
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :authentication_code_1 (required, String)

    An authentication code emitted by the device.

    The format for this parameter is a sequence of six digits.

  • :authentication_code_2 (required, String)

    A subsequent authentication code emitted by the device.

    The format for this parameter is a sequence of six digits.

Returns:

  • (EmptyStructure)


156
157
158
159
160
161
162
163
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 156

def resync(options = {})
  options = options.merge(
    user_name: @user_name,
    serial_number: @serial_number
  )
  resp = @client.resync_mfa_device(options)
  resp.data
end

#serial_numberString

Returns:

  • (String)


37
38
39
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 37

def serial_number
  @serial_number
end

#userUser

Returns:



168
169
170
171
172
173
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 168

def user
  User.new(
    name: @user_name,
    client: @client
  )
end

#user_nameString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/mfa_device.rb', line 32

def user_name
  @user_name
end