software.amazon.awscdk.services.iam

Interface CfnVirtualMFADeviceProps

All Known Implementing Classes:

CfnVirtualMFADeviceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:57.762Z")
public interface CfnVirtualMFADeviceProps

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnVirtualMFADeviceProps.Builder A builder for CfnVirtualMFADeviceProps
static class	CfnVirtualMFADeviceProps.Jsii$Proxy An implementation for CfnVirtualMFADeviceProps

Method Summary

Modifier and Type	Method and Description
static CfnVirtualMFADeviceProps.Builder	builder()
default java.lang.String	getPath() The path for the virtual MFA device.
default java.util.List<CfnTag>	getTags() A list of tags that you want to attach to the new IAM virtual MFA device.
java.util.List<java.lang.String>	getUsers() The IAM user associated with this virtual MFA device.
default java.lang.String	getVirtualMfaDeviceName() The name of the virtual MFA device.

Method Detail

getUsers

java.util.List<java.lang.String> getUsers()

The IAM user associated with this virtual MFA device.

getPath

default java.lang.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

default java.util.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

default java.lang.String getVirtualMfaDeviceName()

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

builder

static CfnVirtualMFADeviceProps.Builder builder()

Returns:

a CfnVirtualMFADeviceProps.Builder of CfnVirtualMFADeviceProps