1.204.0

interface CfnVirtualMFADeviceProps

LanguageType name
.NETAmazon.CDK.AWS.IAM.CfnVirtualMFADeviceProps
Javasoftware.amazon.awscdk.services.iam.CfnVirtualMFADeviceProps
Pythonaws_cdk.aws_iam.CfnVirtualMFADeviceProps
TypeScript @aws-cdk/aws-iam » CfnVirtualMFADeviceProps

Properties for defining a CfnVirtualMFADevice.

Example

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

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

Properties

NameTypeDescription
usersstring[]The IAM user associated with this virtual MFA device.
path?stringThe path for the virtual MFA device.
tags?CfnTag[]A list of tags that you want to attach to the new IAM virtual MFA device.
virtualMfaDeviceName?stringThe name of the virtual MFA device, which must be unique.

users

Type: string[]

The IAM user associated with this virtual MFA device.

path?

Type: string (optional)

The path for the virtual MFA device.

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.

tags?

Type: CfnTag[] (optional)

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

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.

virtualMfaDeviceName?

Type: string (optional)

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

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

← PreviousNext →