CfnVirtualMFADeviceProps¶
-
class
aws_cdk.aws_iam.
CfnVirtualMFADeviceProps
(*, users, path=None, tags=None, virtual_mfa_device_name=None)¶ Bases:
object
Properties for defining a
CfnVirtualMFADevice
.- Parameters
users (
Sequence
[str
]) – The IAM user associated with this virtual MFA device.path (
Optional
[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 (
Optional
[Sequence
[CfnTag
]]) – 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 . .. epigraph:: 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 (
Optional
[str
]) –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: _+=,.@-
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iam as iam cfn_virtual_mFADevice_props = iam.CfnVirtualMFADeviceProps( users=["users"], # the properties below are optional path="path", tags=[CfnTag( key="key", value="value" )], virtual_mfa_device_name="virtualMfaDeviceName" )
Attributes
-
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.
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 . .. epigraph:
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.
- Link
- Return type
Optional
[List
[CfnTag
]]
-
users
¶ The IAM user associated with this virtual MFA device.
-
virtual_mfa_device_name
¶ 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: _+=,.@-