com.ibm.cloud.objectstorage.services.s3.model

Class MultiFactorAuthentication

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.MultiFactorAuthentication

All Implemented Interfaces:

Serializable

public class MultiFactorAuthentication
extends Object
implements Serializable

Contains Multi-Factor Authentication (MFA) information to be included in Amazon S3 requests, consisting of the serial number of the MFA device associated with your Amazon Web Services account and the current, unique MFA token generated by that device.

Each unique token generated by an MFA device can only be used in one request. It is not valid to reuse the same token in additional requests.

For more information about uses of Multi-Factor Authentication in S3 operations, see BucketVersioningConfiguration and the explanation of the MFA Delete functionality.

For more information on Amazon Web Services Multi-Factor Authentication, including how to get a device and associate it with an Amazon Web Services account, see http://aws.amazon.com/mfa

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultiFactorAuthentication(String deviceSerialNumber, String token) Constructs a new MultiFactorAuthentication object for use in any Amazon S3 operation that accepts requests with Multi-Factor Authentication (MFA).

Method Summary

Modifier and Type	Method and Description
String	getDeviceSerialNumber() Gets the Multi-Factor Authentication device serial number.
String	getToken() Gets the Multi-Factor Authentication token.
void	setDeviceSerialNumber(String deviceSerialNumber) Sets the serial number of the Multi-Factor Authentication device associated with the caller's Amazon Web Services account.
void	setToken(String token) Sets the current unique Multi-Factor Authentication token generated by the device associated with the caller's Amazon Web Services account.
MultiFactorAuthentication	withDeviceSerialNumber(String deviceSerialNumber) Sets the Multi-Factor Authentication device serial number to include with this request.
MultiFactorAuthentication	withToken(String token) Sets the current, unique Multi-Factor Authentication token generated by the device associated with the caller's Amazon Web Services account.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiFactorAuthentication

public MultiFactorAuthentication(String deviceSerialNumber,
                                 String token)

Constructs a new MultiFactorAuthentication object for use in any Amazon S3 operation that accepts requests with Multi-Factor Authentication (MFA).

Parameters:

deviceSerialNumber - The serial number identifying the MFA device associated with the caller's Amazon Web Services account.

token - The current unique token generated by the MFA device.

Method Detail

getDeviceSerialNumber

public String getDeviceSerialNumber()

Gets the Multi-Factor Authentication device serial number.

Returns:

The Multi-Factor Authentication device serial number.

See Also:

MultiFactorAuthentication.setDeviceSerialNumber(String), MultiFactorAuthentication.withDeviceSerialNumber(String)

setDeviceSerialNumber

public void setDeviceSerialNumber(String deviceSerialNumber)

Sets the serial number of the Multi-Factor Authentication device associated with the caller's Amazon Web Services account.

Parameters:

deviceSerialNumber - The Multi-Factor Authentication device serial number for the device associated with the caller's Amazon Web Services account.

See Also:

MultiFactorAuthentication.getDeviceSerialNumber(), MultiFactorAuthentication.withDeviceSerialNumber(String)

withDeviceSerialNumber

public MultiFactorAuthentication withDeviceSerialNumber(String deviceSerialNumber)

Sets the Multi-Factor Authentication device serial number to include with this request. Returns this MultiFactorAuthentication, enabling additional method calls to be chained together.

Parameters:

deviceSerialNumber - The serial number of the Multi-Factor Authentication device associated with the caller's Amazon Web Services account.

Returns:

This MultiFactorAuthentication, enabling additional method calls to be chained together.

See Also:

MultiFactorAuthentication.getDeviceSerialNumber(), MultiFactorAuthentication.setDeviceSerialNumber(String)

getToken

public String getToken()

Gets the Multi-Factor Authentication token.

Returns:

The Multi-Factor Authentication token.

See Also:

MultiFactorAuthentication.setToken(String), MultiFactorAuthentication.withToken(String)

setToken

public void setToken(String token)

Sets the current unique Multi-Factor Authentication token generated by the device associated with the caller's Amazon Web Services account.

Parameters:

token - The current, unique Multi-Factor Authentication token generated by the device associated with the caller's Amazon Web Services account.

See Also:

MultiFactorAuthentication.getToken(), MultiFactorAuthentication.withToken(String)

withToken

public MultiFactorAuthentication withToken(String token)

Sets the current, unique Multi-Factor Authentication token generated by the device associated with the caller's Amazon Web Services account. Returns this MultiFactorAuthentication, enabling additional method calls to be chained together.

Parameters:

token - The current, unique Multi-Factor Authentication token generated by the device associated with the caller's Amazon Web Services account.

Returns:

This MultiFactorAuthentication, enabling additional method calls to be chained together.

See Also:

MultiFactorAuthentication.getToken(), MultiFactorAuthentication.setToken(String)