Table of Contents

Class CfnVirtualMFADevice

Namespace
Amazon.CDK.AWS.IAM
Assembly
Amazon.CDK.AWS.IAM.dll

A CloudFormation AWS::IAM::VirtualMFADevice.

public class CfnVirtualMFADevice : CfnResource, IInspectable
Inheritance
CfnVirtualMFADevice
Implements
IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IAM;

             var cfnVirtualMFADevice = new CfnVirtualMFADevice(this, "MyCfnVirtualMFADevice", new CfnVirtualMFADeviceProps {
                 Users = new [] { "users" },

                 // the properties below are optional
                 Path = "path",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualMfaDeviceName = "virtualMfaDeviceName"
             });

Remarks

Creates a new virtual MFA device for the AWS account . After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide .

For information about the maximum number of MFA devices you can create, see IAM and AWS STS quotas in the IAM User Guide .

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

CloudformationResource: AWS::IAM::VirtualMFADevice

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html

ExampleMetadata: fixture=_generated

Constructors

CfnVirtualMFADevice(Construct, string, ICfnVirtualMFADeviceProps)

Create a new AWS::IAM::VirtualMFADevice.

public CfnVirtualMFADevice(Construct scope, string id, ICfnVirtualMFADeviceProps props)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnVirtualMFADeviceProps
  • resource properties.

Properties

AttrSerialNumber

Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.

public virtual string AttrSerialNumber { get; }

Property Value

string

Remarks

CloudformationAttribute: SerialNumber

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties 

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Path

The path for the virtual MFA device.

public virtual string? Path { get; set; }

Property Value

string

Remarks

For more information about paths, see IAM identifiers in the IAM User Guide .

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-path

Tags

A list of tags that you want to attach to the new IAM virtual MFA device.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-tags

Users

The IAM user associated with this virtual MFA device.

public virtual string[] Users { get; set; }

Property Value

string[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-users

VirtualMfaDeviceName

The name of the virtual MFA device, which must be unique.

public virtual string? VirtualMfaDeviceName { get; set; }

Property Value

string

Remarks

Use with path to uniquely identify a virtual MFA device.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html#cfn-iam-virtualmfadevice-virtualmfadevicename

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>) 

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>