Package software.amazon.awscdk.services.iam

Class CfnVirtualMFADevice

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iam.CfnVirtualMFADevice
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:44.406Z") @Stability(Stable) public class CfnVirtualMFADevice extends CfnResource implements IInspectable, ITaggable
Creates a new virtual MFA device for the AWS 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 AWS 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 AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 CfnVirtualMFADevice cfnVirtualMFADevice = CfnVirtualMFADevice.Builder.create(this, "MyCfnVirtualMFADevice")
         .users(List.of("users"))
         // the properties below are optional
         .path("path")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualMfaDeviceName("virtualMfaDeviceName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVirtualMFADevice

      protected CfnVirtualMFADevice(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVirtualMFADevice

      protected CfnVirtualMFADevice(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVirtualMFADevice

      @Stability(Stable) public CfnVirtualMFADevice(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVirtualMFADeviceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrSerialNumber

      @Stability(Stable) @NotNull public String getAttrSerialNumber()
      Returns the serial number for the specified AWS::IAM::VirtualMFADevice resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getUsers

      @Stability(Stable) @NotNull public List<String> getUsers()
      The IAM user associated with this virtual MFA device.

    • setUsers

      @Stability(Stable) public void setUsers(@NotNull List<String> value)
      The IAM user associated with this virtual MFA device.

    • getPath

      @Stability(Stable) @Nullable public String getPath()
      The path for the virtual MFA device.

    • setPath

      @Stability(Stable) public void setPath(@Nullable String value)
      The path for the virtual MFA device.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of tags that you want to attach to the new IAM virtual MFA device.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of tags that you want to attach to the new IAM virtual MFA device.

    • getVirtualMfaDeviceName

      @Stability(Stable) @Nullable public String getVirtualMfaDeviceName()
      The name of the virtual MFA device, which must be unique.

    • setVirtualMfaDeviceName

      @Stability(Stable) public void setVirtualMfaDeviceName(@Nullable String value)
      The name of the virtual MFA device, which must be unique.