You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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
}

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.

Returns:

  • (String)


1635
1636
1637
1638
1639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1635

class CreateVirtualMFADeviceRequest < Struct.new(
  :path,
  :virtual_mfa_device_name)
  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: _+=,.@-

Returns:

  • (String)


1635
1636
1637
1638
1639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1635

class CreateVirtualMFADeviceRequest < Struct.new(
  :path,
  :virtual_mfa_device_name)
  include Aws::Structure
end