VirtualMfaDevice class

Provides an IAM Virtual MFA Device.

> Note: All attributes will be stored in the raw state as plain-text. > Note: A virtual MFA device cannot be directly associated with an IAM User from the provider. To associate the virtual MFA device with a user and enable it, use the code returned in either base32StringSeed or qrCodePng to generate TOTP authentication codes. The authentication codes can then be used with the AWS CLI command aws iam enable-mfa-device or the AWS API call EnableMFADevice.

Example Usage

Using certs on file:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.iam.VirtualMfaDevice("example", {virtualMfaDeviceName: "example"});
import pulumi
import pulumi_aws as aws

example = aws.iam.VirtualMfaDevice("example", virtual_mfa_device_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Iam.VirtualMfaDevice("example", new()
    {
        VirtualMfaDeviceName = "example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.NewVirtualMfaDevice(ctx, "example", &iam.VirtualMfaDeviceArgs{
			VirtualMfaDeviceName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_iam_virtualmfadevice" "example" {
  virtual_mfa_device_name = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.VirtualMfaDevice;
import com.pulumi.aws.iam.VirtualMfaDeviceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new VirtualMfaDevice("example", VirtualMfaDeviceArgs.builder()
            .virtualMfaDeviceName("example")
            .build());

    }
}
resources:
  example:
    type: aws:iam:VirtualMfaDevice
    properties:
      virtualMfaDeviceName: example

Import

Using pulumi import, import IAM Virtual MFA Devices using the arn. For example:

$ pulumi import aws:iam/virtualMfaDevice:VirtualMfaDevice example arn:aws:iam::123456789012:mfa/example

Constructors

VirtualMfaDevice(String name, {VirtualMfaDeviceArgs? args, CustomResourceOptions? options})
Creates a new VirtualMfaDevice. name The Pulumi resource name. args Arguments used to configure this VirtualMfaDevice. The set of arguments for VirtualMfaDevice. options Resource options controlling this resource's behavior.
VirtualMfaDevice.reference(String urn)
Creates a typed reference to an existing VirtualMfaDevice resource.

Properties

arn ↔ Output<String>
ARN, which is also the serial number, of the virtual MFA device.
latefinal
base32StringSeed ↔ Output<String>
Base32 seed defined as specified in RFC3548. The base32StringSeed is base64-encoded.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
enableDate ↔ Output<String>
Date and time when the virtual MFA device was enabled.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
path ↔ Output<String?>
Path for the virtual MFA device.
latefinal
qrCodePng ↔ Output<String>
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), and Base32String is the seed in base32 format.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serialNumber ↔ Output<String>
Serial number associated with the virtual MFA device.
latefinal
tags ↔ Output<Map<String, String>?>
Map of resource tags for the virtual mfa device. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
userName ↔ Output<String>
Name of the IAM user associated with this virtual MFA device.
latefinal
virtualMfaDeviceName ↔ Output<String>
Name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {VirtualMfaDeviceState? state, CustomResourceOptions? options}) → VirtualMfaDevice
Gets an existing VirtualMfaDevice resource's state with the given name and id.