software.amazon.awssdk.services.iam.model

Class CreateVirtualMfaDeviceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iam.model.IamRequest

software.amazon.awssdk.services.iam.model.CreateVirtualMfaDeviceRequest

All Implemented Interfaces:

ToCopyableBuilder<CreateVirtualMfaDeviceRequest.Builder,CreateVirtualMfaDeviceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateVirtualMfaDeviceRequest
extends IamRequest
implements ToCopyableBuilder<CreateVirtualMfaDeviceRequest.Builder,CreateVirtualMfaDeviceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateVirtualMfaDeviceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateVirtualMfaDeviceRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	path() The path for the virtual MFA device.
static Class<? extends CreateVirtualMfaDeviceRequest.Builder>	serializableBuilderClass()
CreateVirtualMfaDeviceRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	virtualMFADeviceName() The name of the virtual MFA device.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

path

public String 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 paramater allows (per 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, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

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 paramater allows (per 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, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

virtualMFADeviceName

public String virtualMFADeviceName()

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

This parameter allows (per 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: =,.@-

Returns:

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

This parameter allows (per 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: =,.@-

toBuilder

public CreateVirtualMfaDeviceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVirtualMfaDeviceRequest.Builder,CreateVirtualMfaDeviceRequest>

Specified by:

toBuilder in class IamRequest

Returns:

a builder for type T

builder

public static CreateVirtualMfaDeviceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateVirtualMfaDeviceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value