libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data CreateVirtualMFADevice Source #

See: newCreateVirtualMFADevice smart constructor.

Constructors

CreateVirtualMFADevice' 

Fields

  • path :: Maybe Text

    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 :: Maybe [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.

    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 :: Text

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

Instances

Instances details
Eq CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Read CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Show CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Generic CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Associated Types

type Rep CreateVirtualMFADevice :: Type -> Type #

NFData CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Methods

rnf :: CreateVirtualMFADevice -> () #

Hashable CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

AWSRequest CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Associated Types

type AWSResponse CreateVirtualMFADevice #

ToHeaders CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

ToPath CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

ToQuery CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

type Rep CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

type Rep CreateVirtualMFADevice = D1 ('MetaData "CreateVirtualMFADevice" "Amazonka.IAM.CreateVirtualMFADevice" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreateVirtualMFADevice'" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "virtualMFADeviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateVirtualMFADevice Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

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

Instances details
Eq CreateVirtualMFADeviceResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Show CreateVirtualMFADeviceResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Generic CreateVirtualMFADeviceResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

Associated Types

type Rep CreateVirtualMFADeviceResponse :: Type -> Type #

NFData CreateVirtualMFADeviceResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

type Rep CreateVirtualMFADeviceResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateVirtualMFADevice

type Rep CreateVirtualMFADeviceResponse = D1 ('MetaData "CreateVirtualMFADeviceResponse" "Amazonka.IAM.CreateVirtualMFADevice" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreateVirtualMFADeviceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "virtualMFADevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VirtualMFADevice)))

newCreateVirtualMFADeviceResponse Source #

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_virtualMFADevice :: Lens' CreateVirtualMFADeviceResponse VirtualMFADevice Source #

A structure containing details about the new virtual MFA device.