com.amazonaws.services.identitymanagement.model

Class EnableMFADeviceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.EnableMFADeviceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class EnableMFADeviceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the EnableMFADevice operation.

Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device.

See Also:

AmazonIdentityManagement.enableMFADevice(EnableMFADeviceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
EnableMFADeviceRequest() Default constructor for a new EnableMFADeviceRequest object.
EnableMFADeviceRequest(String userName, String serialNumber, String authenticationCode1, String authenticationCode2) Constructs a new EnableMFADeviceRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
EnableMFADeviceRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAuthenticationCode1() An authentication code emitted by the device.
String	getAuthenticationCode2() A subsequent authentication code emitted by the device.
String	getSerialNumber() The serial number that uniquely identifies the MFA device.
String	getUserName() The name of the user for whom you want to enable the MFA device.
int	hashCode()
void	setAuthenticationCode1(String authenticationCode1) An authentication code emitted by the device.
void	setAuthenticationCode2(String authenticationCode2) A subsequent authentication code emitted by the device.
void	setSerialNumber(String serialNumber) The serial number that uniquely identifies the MFA device.
void	setUserName(String userName) The name of the user for whom you want to enable the MFA device.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EnableMFADeviceRequest	withAuthenticationCode1(String authenticationCode1) An authentication code emitted by the device.
EnableMFADeviceRequest	withAuthenticationCode2(String authenticationCode2) A subsequent authentication code emitted by the device.
EnableMFADeviceRequest	withSerialNumber(String serialNumber) The serial number that uniquely identifies the MFA device.
EnableMFADeviceRequest	withUserName(String userName) The name of the user for whom you want to enable the MFA device.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnableMFADeviceRequest

public EnableMFADeviceRequest()

Default constructor for a new EnableMFADeviceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

EnableMFADeviceRequest

public EnableMFADeviceRequest(String userName,
                      String serialNumber,
                      String authenticationCode1,
                      String authenticationCode2)

Constructs a new EnableMFADeviceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

userName - The name of the user for whom you want to enable the MFA device.

serialNumber - The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

authenticationCode1 - An authentication code emitted by the device.

authenticationCode2 - A subsequent authentication code emitted by the device.

Method Detail

getUserName

public String getUserName()

The name of the user for whom you want to enable the MFA device.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Returns:

The name of the user for whom you want to enable the MFA device.

setUserName

public void setUserName(String userName)

The name of the user for whom you want to enable the MFA device.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

userName - The name of the user for whom you want to enable the MFA device.

withUserName

public EnableMFADeviceRequest withUserName(String userName)

The name of the user for whom you want to enable the MFA device.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

userName - The name of the user for whom you want to enable the MFA device.

Returns:

A reference to this updated object so that method calls can be chained together.

getSerialNumber

public String getSerialNumber()

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]+

Returns:

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

setSerialNumber

public void setSerialNumber(String serialNumber)

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]+

Parameters:

serialNumber - The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

withSerialNumber

public EnableMFADeviceRequest withSerialNumber(String serialNumber)

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]+

Parameters:

serialNumber - The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

Returns:

A reference to this updated object so that method calls can be chained together.

getAuthenticationCode1

public String getAuthenticationCode1()

An authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]+

Returns:

An authentication code emitted by the device.

setAuthenticationCode1

public void setAuthenticationCode1(String authenticationCode1)

An authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]+

Parameters:

authenticationCode1 - An authentication code emitted by the device.

withAuthenticationCode1

public EnableMFADeviceRequest withAuthenticationCode1(String authenticationCode1)

An authentication code emitted by the device.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 6 - 6
Pattern: [\d]+

Parameters:

authenticationCode1 - An authentication code emitted by the device.

Returns:

A reference to this updated object so that method calls can be chained together.

getAuthenticationCode2

public String getAuthenticationCode2()

A subsequent authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]+

Returns:

A subsequent authentication code emitted by the device.

setAuthenticationCode2

public void setAuthenticationCode2(String authenticationCode2)

A subsequent authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]+

Parameters:

authenticationCode2 - A subsequent authentication code emitted by the device.

withAuthenticationCode2

public EnableMFADeviceRequest withAuthenticationCode2(String authenticationCode2)

A subsequent authentication code emitted by the device.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 6 - 6
Pattern: [\d]+

Parameters:

authenticationCode2 - A subsequent authentication code emitted by the device.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public EnableMFADeviceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()