aws-cdk-lib.aws_iam.CfnVirtualMFADeviceProps

CfnVirtualMFADeviceProps Struct

Properties for defining a CfnVirtualMFADevice.

Source

Generated code

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';
const cfnVirtualMFADeviceProps: iam.CfnVirtualMFADeviceProps = {
  users: ['users'],

  // the properties below are optional
  path: 'path',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  virtualMfaDeviceName: 'virtualMfaDeviceName',
};

Properties

pathstringpathstrpathStringPathstringPath*string#

The path for the virtual MFA device.

notes

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.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

notes

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.

usersstring[]userstyping.List[str]usersList<String>Usersstring[]Users*[]*stringrequired#

The IAM user associated with this virtual MFA device.

virtualMfaDeviceNamestringvirtual_mfa_device_namestrvirtualMfaDeviceNameStringVirtualMfaDeviceNamestringVirtualMfaDeviceName*string#

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

notes

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: _+=,.@-

Used as props by

• CfnVirtualMFADevice