Class VirtualMFADevice
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VirtualMFADevice.Builder,
VirtualMFADevice>
Contains information about a virtual MFA device.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal SdkBytes
The base32 seed defined as specified in RFC3548.static VirtualMFADevice.Builder
builder()
final Instant
The date and time on which the virtual MFA device was enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final SdkBytes
A QR code PNG image that encodesotpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String
where$virtualMFADeviceName
is one of the create call arguments.static Class
<? extends VirtualMFADevice.Builder> final String
The serial number associated withVirtualMFADevice
.tags()
A list of tags that are attached to the virtual MFA device.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final User
user()
The IAM user associated with this virtual MFA device.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
serialNumber
The serial number associated with
VirtualMFADevice
.- Returns:
- The serial number associated with
VirtualMFADevice
.
-
base32StringSeed
The base32 seed defined as specified in RFC3548. The
Base32StringSeed
is base32-encoded.- Returns:
- The base32 seed defined as specified in RFC3548.
The
Base32StringSeed
is base32-encoded.
-
qrCodePNG
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), andBase32String
is the seed in base32 format. TheBase32String
value is base64-encoded.- Returns:
- 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), andBase32String
is the seed in base32 format. TheBase32String
value is base64-encoded.
-
user
The IAM user associated with this virtual MFA device.
- Returns:
- The IAM user associated with this virtual MFA device.
-
enableDate
The date and time on which the virtual MFA device was enabled.
- Returns:
- The date and time on which the virtual MFA device was enabled.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<VirtualMFADevice.Builder,
VirtualMFADevice> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-