| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IAM.CreateVirtualMFADevice
Description
Creates a new virtual MFA device for the Amazon Web Services 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 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 Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
Synopsis
- data CreateVirtualMFADevice = CreateVirtualMFADevice' {}
- newCreateVirtualMFADevice :: Text -> CreateVirtualMFADevice
- createVirtualMFADevice_path :: Lens' CreateVirtualMFADevice (Maybe Text)
- createVirtualMFADevice_tags :: Lens' CreateVirtualMFADevice (Maybe [Tag])
- createVirtualMFADevice_virtualMFADeviceName :: Lens' CreateVirtualMFADevice Text
- data CreateVirtualMFADeviceResponse = CreateVirtualMFADeviceResponse' {}
- newCreateVirtualMFADeviceResponse :: Int -> VirtualMFADevice -> CreateVirtualMFADeviceResponse
- createVirtualMFADeviceResponse_httpStatus :: Lens' CreateVirtualMFADeviceResponse Int
- createVirtualMFADeviceResponse_virtualMFADevice :: Lens' CreateVirtualMFADeviceResponse VirtualMFADevice
Creating a Request
data CreateVirtualMFADevice Source #
See: newCreateVirtualMFADevice smart constructor.
Constructors
| CreateVirtualMFADevice' | |
Fields
| |
Instances
newCreateVirtualMFADevice Source #
Create a value of CreateVirtualMFADevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:path:CreateVirtualMFADevice', createVirtualMFADevice_path - 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.
$sel:tags:CreateVirtualMFADevice', createVirtualMFADevice_tags - 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.
$sel:virtualMFADeviceName:CreateVirtualMFADevice', createVirtualMFADevice_virtualMFADeviceName - 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: _+=,.@-
Request Lenses
createVirtualMFADevice_path :: Lens' CreateVirtualMFADevice (Maybe Text) Source #
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.
createVirtualMFADevice_tags :: Lens' CreateVirtualMFADevice (Maybe [Tag]) Source #
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.
createVirtualMFADevice_virtualMFADeviceName :: Lens' CreateVirtualMFADevice Text Source #
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: _+=,.@-
Destructuring the Response
data CreateVirtualMFADeviceResponse Source #
Contains the response to a successful CreateVirtualMFADevice request.
See: newCreateVirtualMFADeviceResponse smart constructor.
Constructors
| CreateVirtualMFADeviceResponse' | |
Fields
| |
Instances
newCreateVirtualMFADeviceResponse Source #
Arguments
| :: Int | |
| -> VirtualMFADevice | |
| -> CreateVirtualMFADeviceResponse |
Create a value of CreateVirtualMFADeviceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateVirtualMFADeviceResponse', createVirtualMFADeviceResponse_httpStatus - The response's http status code.
$sel:virtualMFADevice:CreateVirtualMFADeviceResponse', createVirtualMFADeviceResponse_virtualMFADevice - A structure containing details about the new virtual MFA device.
Response Lenses
createVirtualMFADeviceResponse_httpStatus :: Lens' CreateVirtualMFADeviceResponse Int Source #
The response's http status code.
createVirtualMFADeviceResponse_virtualMFADevice :: Lens' CreateVirtualMFADeviceResponse VirtualMFADevice Source #
A structure containing details about the new virtual MFA device.