Class: Aws::IAM::VirtualMfaDevice
- Inherits:
-
Object
- Object
- Aws::IAM::VirtualMfaDevice
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-iam/virtual_mfa_device.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#base_32_string_seed ⇒ String
The base32 seed defined as specified in [RFC3548].
-
#enable_date ⇒ Time
The date and time on which the virtual MFA device was enabled.
-
#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.
- #serial_number ⇒ String
Actions collapse
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #user ⇒ User?
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::VirtualMFADevice
Returns the data for this VirtualMfaDevice.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ VirtualMfaDevice
constructor
A new instance of VirtualMfaDevice.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::IAM::Client] #wait_until instead
Constructor Details
#initialize(serial_number, options = {}) ⇒ VirtualMfaDevice #initialize(options = {}) ⇒ VirtualMfaDevice
Returns a new instance of VirtualMfaDevice.
22 23 24 25 26 27 28 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @serial_number = extract_serial_number(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#base_32_string_seed ⇒ String
The base32 seed defined as specified in [RFC3548]. The ‘Base32StringSeed` is base64-encoded.
44 45 46 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 44 def base_32_string_seed data[:base_32_string_seed] end |
#client ⇒ Client
68 69 70 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 68 def client @client end |
#data ⇒ Types::VirtualMFADevice
Returns the data for this Aws::IAM::VirtualMfaDevice.
83 84 85 86 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 83 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
91 92 93 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 91 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
199 200 201 202 203 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 199 def delete( = {}) = .merge(serial_number: @serial_number) resp = @client.delete_virtual_mfa_device() resp.data end |
#enable_date ⇒ Time
The date and time on which the virtual MFA device was enabled.
61 62 63 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 61 def enable_date data[:enable_date] end |
#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.
221 222 223 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 221 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.
74 75 76 77 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 74 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.
55 56 57 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 55 def qr_code_png data[:qr_code_png] end |
#serial_number ⇒ String
33 34 35 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 33 def serial_number @serial_number end |
#user ⇒ User?
208 209 210 211 212 213 214 215 216 217 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 208 def user if data[:user][:user_name] User.new( name: data[:user][:user_name], client: @client ) else nil end end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::IAM::Client] #wait_until instead
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() {|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
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/aws-sdk-iam/virtual_mfa_device.rb', line 175 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |