Class: Aws::IAM::Types::CreateVirtualMFADeviceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass CreateVirtualMFADeviceRequest data as a hash:

{
  path: "pathType",
  virtual_mfa_device_name: "virtualMFADeviceName", # required
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#pathString

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.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html [2]: wikipedia.org/wiki/regex

Returns:

  • (String)

1840
1841
1842
1843
1844
1845
1846
# File 'lib/aws-sdk-iam/types.rb', line 1840

class CreateVirtualMFADeviceRequest < Struct.new(
  :path,
  :virtual_mfa_device_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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*.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:


1840
1841
1842
1843
1844
1845
1846
# File 'lib/aws-sdk-iam/types.rb', line 1840

class CreateVirtualMFADeviceRequest < Struct.new(
  :path,
  :virtual_mfa_device_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_mfa_device_nameString

The name of the virtual MFA device. 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: _+=,[email protected]

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)

1840
1841
1842
1843
1844
1845
1846
# File 'lib/aws-sdk-iam/types.rb', line 1840

class CreateVirtualMFADeviceRequest < Struct.new(
  :path,
  :virtual_mfa_device_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end