Class VirtualMFADevice
- java.lang.Object
-
- software.amazon.awssdk.services.iam.model.VirtualMFADevice
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<VirtualMFADevice.Builder,VirtualMFADevice>
@Generated("software.amazon.awssdk:codegen") public final class VirtualMFADevice extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VirtualMFADevice.Builder,VirtualMFADevice>
Contains information about a virtual MFA device.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceVirtualMFADevice.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SdkBytesbase32StringSeed()The base32 seed defined as specified in RFC3548.static VirtualMFADevice.Builderbuilder()InstantenableDate()The date and time on which the virtual MFA device was enabled.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.SdkBytesqrCodePNG()A QR code PNG image that encodesotpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32Stringwhere$virtualMFADeviceNameis one of the create call arguments.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends VirtualMFADevice.Builder>serializableBuilderClass()StringserialNumber()The serial number associated withVirtualMFADevice.List<Tag>tags()A list of tags that are attached to the virtual MFA device.VirtualMFADevice.BuildertoBuilder()StringtoString()Returns a string representation of this object.Useruser()The IAM user associated with this virtual MFA device.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
serialNumber
public final String serialNumber()
The serial number associated with
VirtualMFADevice.- Returns:
- The serial number associated with
VirtualMFADevice.
-
base32StringSeed
public final SdkBytes base32StringSeed()
The base32 seed defined as specified in RFC3548. The
Base32StringSeedis base32-encoded.- Returns:
- The base32 seed defined as specified in RFC3548.
The
Base32StringSeedis base32-encoded.
-
qrCodePNG
public final SdkBytes qrCodePNG()
A QR code PNG image that encodes
otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32Stringwhere$virtualMFADeviceNameis one of the create call arguments.AccountNameis the user name if set (otherwise, the account ID otherwise), andBase32Stringis the seed in base32 format. TheBase32Stringvalue is base64-encoded.- Returns:
- A QR code PNG image that encodes
otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32Stringwhere$virtualMFADeviceNameis one of the create call arguments.AccountNameis the user name if set (otherwise, the account ID otherwise), andBase32Stringis the seed in base32 format. TheBase32Stringvalue is base64-encoded.
-
user
public final User user()
The IAM user associated with this virtual MFA device.
- Returns:
- The IAM user associated with this virtual MFA device.
-
enableDate
public final Instant 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
public final List<Tag> 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
public VirtualMFADevice.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<VirtualMFADevice.Builder,VirtualMFADevice>
-
builder
public static VirtualMFADevice.Builder builder()
-
serializableBuilderClass
public static Class<? extends VirtualMFADevice.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-