Package software.amazon.awscdk.services.iam

Interface CfnVirtualMFADeviceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnVirtualMFADeviceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.300Z") @Stability(Stable) public interface CfnVirtualMFADeviceProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnVirtualMFADevice.

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.*;
 CfnVirtualMFADeviceProps cfnVirtualMFADeviceProps = CfnVirtualMFADeviceProps.builder()
         .users(List.of("users"))
         // the properties below are optional
         .path("path")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualMfaDeviceName("virtualMfaDeviceName")
         .build();

  • Method Details

    • getUsers

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

    • getPath

      @Stability(Stable) @Nullable default 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.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> 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.

    • getVirtualMfaDeviceName

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

    • builder

      @Stability(Stable) static CfnVirtualMFADeviceProps.Builder builder()
      Returns:
      a CfnVirtualMFADeviceProps.Builder of CfnVirtualMFADeviceProps