Package software.amazon.awscdk.services.iam

Class CfnVirtualMFADevice

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iam.CfnVirtualMFADevice
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.298Z") @Stability(Stable) public class CfnVirtualMFADevice extends CfnResource implements IInspectable
A CloudFormation AWS::IAM::VirtualMFADevice.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnVirtualMFADeviceProps props)
      Create a new AWS::IAM::VirtualMFADevice.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()
      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.

    • 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.

      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.

    • setPath

      @Stability(Stable) public void setPath(@Nullable String value)
      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.

    • getVirtualMfaDeviceName

      @Stability(Stable) @Nullable public String getVirtualMfaDeviceName()
      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: _+=,.@-

    • setVirtualMfaDeviceName

      @Stability(Stable) public void setVirtualMfaDeviceName(@Nullable String value)
      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: _+=,.@-