com.amazonaws.services.identitymanagement.model.EnableMFADeviceRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.identitymanagement.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.identitymanagement.AmazonIdentityManagement#enableMFADevice(EnableMFADeviceRequest) 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 com.amazonaws.services.identitymanagement.AmazonIdentityManagement#enableMFADevice(EnableMFADeviceRequest)
*/
public class EnableMFADeviceRequest extends AmazonWebServiceRequest implements Serializable {
/**
* Name of the user for whom you want to enable the MFA device.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*/
private String userName;
/**
* 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+=/:,.@-]*
*/
private String serialNumber;
/**
* An authentication code emitted by the device.
*
* Constraints:
* Length: 6 - 6
* Pattern: [\d]*
*/
private String authenticationCode1;
/**
* A subsequent authentication code emitted by the device.
*
* Constraints:
* Length: 6 - 6
* Pattern: [\d]*
*/
private String authenticationCode2;
/**
* Default constructor for a new EnableMFADeviceRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public EnableMFADeviceRequest() {}
/**
* Constructs a new EnableMFADeviceRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param userName Name of the user for whom you want to enable the MFA
* device.
* @param serialNumber The serial number that uniquely identifies the MFA
* device. For virtual MFA devices, the serial number is the device ARN.
* @param authenticationCode1 An authentication code emitted by the
* device.
* @param authenticationCode2 A subsequent authentication code emitted by
* the device.
*/
public EnableMFADeviceRequest(String userName, String serialNumber, String authenticationCode1, String authenticationCode2) {
setUserName(userName);
setSerialNumber(serialNumber);
setAuthenticationCode1(authenticationCode1);
setAuthenticationCode2(authenticationCode2);
}
/**
* Name of the user for whom you want to enable the MFA device.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @return Name of the user for whom you want to enable the MFA device.
*/
public String getUserName() {
return userName;
}
/**
* Name of the user for whom you want to enable the MFA device.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @param userName Name of the user for whom you want to enable the MFA device.
*/
public void setUserName(String userName) {
this.userName = userName;
}
/**
* 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+=,.@-]*
*
* @param userName Name of the user for whom you want to enable the MFA device.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EnableMFADeviceRequest withUserName(String userName) {
this.userName = userName;
return this;
}
/**
* 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+=/:,.@-]*
*
* @return The serial number that uniquely identifies the MFA device. For virtual
* MFA devices, the serial number is the device ARN.
*/
public String getSerialNumber() {
return 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+=/:,.@-]*
*
* @param serialNumber The serial number that uniquely identifies the MFA device. For virtual
* MFA devices, the serial number is the device ARN.
*/
public void setSerialNumber(String serialNumber) {
this.serialNumber = 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+=/:,.@-]*
*
* @param serialNumber The serial number that uniquely identifies the MFA device. For virtual
* MFA devices, the serial number is the device ARN.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EnableMFADeviceRequest withSerialNumber(String serialNumber) {
this.serialNumber = serialNumber;
return this;
}
/**
* An authentication code emitted by the device.
*
* Constraints:
* Length: 6 - 6
* Pattern: [\d]*
*
* @return An authentication code emitted by the device.
*/
public String getAuthenticationCode1() {
return authenticationCode1;
}
/**
* An authentication code emitted by the device.
*
* Constraints:
* Length: 6 - 6
* Pattern: [\d]*
*
* @param authenticationCode1 An authentication code emitted by the device.
*/
public void setAuthenticationCode1(String authenticationCode1) {
this.authenticationCode1 = 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]*
*
* @param authenticationCode1 An authentication code emitted by the device.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EnableMFADeviceRequest withAuthenticationCode1(String authenticationCode1) {
this.authenticationCode1 = authenticationCode1;
return this;
}
/**
* A subsequent authentication code emitted by the device.
*
* Constraints:
* Length: 6 - 6
* Pattern: [\d]*
*
* @return A subsequent authentication code emitted by the device.
*/
public String getAuthenticationCode2() {
return authenticationCode2;
}
/**
* A subsequent authentication code emitted by the device.
*
* Constraints:
* Length: 6 - 6
* Pattern: [\d]*
*
* @param authenticationCode2 A subsequent authentication code emitted by the device.
*/
public void setAuthenticationCode2(String authenticationCode2) {
this.authenticationCode2 = 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]*
*
* @param authenticationCode2 A subsequent authentication code emitted by the device.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EnableMFADeviceRequest withAuthenticationCode2(String authenticationCode2) {
this.authenticationCode2 = authenticationCode2;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUserName() != null) sb.append("UserName: " + getUserName() + ",");
if (getSerialNumber() != null) sb.append("SerialNumber: " + getSerialNumber() + ",");
if (getAuthenticationCode1() != null) sb.append("AuthenticationCode1: " + getAuthenticationCode1() + ",");
if (getAuthenticationCode2() != null) sb.append("AuthenticationCode2: " + getAuthenticationCode2() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserName() == null) ? 0 : getUserName().hashCode());
hashCode = prime * hashCode + ((getSerialNumber() == null) ? 0 : getSerialNumber().hashCode());
hashCode = prime * hashCode + ((getAuthenticationCode1() == null) ? 0 : getAuthenticationCode1().hashCode());
hashCode = prime * hashCode + ((getAuthenticationCode2() == null) ? 0 : getAuthenticationCode2().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof EnableMFADeviceRequest == false) return false;
EnableMFADeviceRequest other = (EnableMFADeviceRequest)obj;
if (other.getUserName() == null ^ this.getUserName() == null) return false;
if (other.getUserName() != null && other.getUserName().equals(this.getUserName()) == false) return false;
if (other.getSerialNumber() == null ^ this.getSerialNumber() == null) return false;
if (other.getSerialNumber() != null && other.getSerialNumber().equals(this.getSerialNumber()) == false) return false;
if (other.getAuthenticationCode1() == null ^ this.getAuthenticationCode1() == null) return false;
if (other.getAuthenticationCode1() != null && other.getAuthenticationCode1().equals(this.getAuthenticationCode1()) == false) return false;
if (other.getAuthenticationCode2() == null ^ this.getAuthenticationCode2() == null) return false;
if (other.getAuthenticationCode2() != null && other.getAuthenticationCode2().equals(this.getAuthenticationCode2()) == false) return false;
return true;
}
}