Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. iam
  5. VirtualMfaDevice

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iam.VirtualMfaDevice

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IAM::VirtualMFADevice

    Create VirtualMfaDevice Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualMfaDevice(name: string, args: VirtualMfaDeviceArgs, opts?: CustomResourceOptions);
    @overload
def VirtualMfaDevice(resource_name: str,
                     args: VirtualMfaDeviceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def VirtualMfaDevice(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     users: Optional[Sequence[str]] = None,
                     path: Optional[str] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                     virtual_mfa_device_name: Optional[str] = None)
    func NewVirtualMfaDevice(ctx *Context, name string, args VirtualMfaDeviceArgs, opts ...ResourceOption) (*VirtualMfaDevice, error)
    public VirtualMfaDevice(string name, VirtualMfaDeviceArgs args, CustomResourceOptions? opts = null)
    public VirtualMfaDevice(String name, VirtualMfaDeviceArgs args)
public VirtualMfaDevice(String name, VirtualMfaDeviceArgs args, CustomResourceOptions options)

    type: aws-native:iam:VirtualMfaDevice
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualMfaDeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualMfaDeviceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualMfaDeviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualMfaDeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualMfaDeviceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    VirtualMfaDevice Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VirtualMfaDevice resource accepts the following input properties:

    Users List<string>
    The IAM user associated with this virtual MFA device.
    Path string

    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 List<Pulumi.AwsNative.Inputs.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 string

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

    Users []string
    The IAM user associated with this virtual MFA device.
    Path string

    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 TagArgs

    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 string

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

    users List<String>
    The IAM user associated with this virtual MFA device.
    path String

    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 List<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 String

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

    users string[]
    The IAM user associated with this virtual MFA device.
    path string

    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 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 string

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

    users Sequence[str]
    The IAM user associated with this virtual MFA device.
    path str

    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 Sequence[TagArgs]

    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.

    virtual_mfa_device_name str

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

    users List<String>
    The IAM user associated with this virtual MFA device.
    path String

    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 List<Property Map>

    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 String

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualMfaDevice resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    SerialNumber string
    Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    SerialNumber string
    Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.
    id String
    The provider-assigned unique ID for this managed resource.
    serialNumber String
    Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.
    id string
    The provider-assigned unique ID for this managed resource.
    serialNumber string
    Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.
    id str
    The provider-assigned unique ID for this managed resource.
    serial_number str
    Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.
    id String
    The provider-assigned unique ID for this managed resource.
    serialNumber String
    Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native