com.amazonaws.services.ec2.model.ImportKeyPairRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2015 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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.ImportKeyPairRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#importKeyPair(ImportKeyPairRequest) ImportKeyPair operation}.
*
* Imports the public key from an RSA key pair that you created with a
* third-party tool. Compare this with CreateKeyPair, in which AWS
* creates the key pair and gives the keys to you (AWS keeps a copy of
* the public key). With ImportKeyPair, you create the key pair and give
* AWS just the public key. The private key is never transferred between
* you and AWS.
*
*
* For more information about key pairs, see
* Key Pairs
* in the Amazon Elastic Compute Cloud User Guide .
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#importKeyPair(ImportKeyPairRequest)
*/
public class ImportKeyPairRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
* A unique name for the key pair.
*/
private String keyName;
/**
* The public key. You must base64 encode the public key material before
* sending it to AWS.
*/
private String publicKeyMaterial;
/**
* Default constructor for a new ImportKeyPairRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public ImportKeyPairRequest() {}
/**
* Constructs a new ImportKeyPairRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param keyName A unique name for the key pair.
* @param publicKeyMaterial The public key. You must base64 encode the
* public key material before sending it to AWS.
*/
public ImportKeyPairRequest(String keyName, String publicKeyMaterial) {
setKeyName(keyName);
setPublicKeyMaterial(publicKeyMaterial);
}
/**
* A unique name for the key pair.
*
* @return A unique name for the key pair.
*/
public String getKeyName() {
return keyName;
}
/**
* A unique name for the key pair.
*
* @param keyName A unique name for the key pair.
*/
public void setKeyName(String keyName) {
this.keyName = keyName;
}
/**
* A unique name for the key pair.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param keyName A unique name for the key pair.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ImportKeyPairRequest withKeyName(String keyName) {
this.keyName = keyName;
return this;
}
/**
* The public key. You must base64 encode the public key material before
* sending it to AWS.
*
* @return The public key. You must base64 encode the public key material before
* sending it to AWS.
*/
public String getPublicKeyMaterial() {
return publicKeyMaterial;
}
/**
* The public key. You must base64 encode the public key material before
* sending it to AWS.
*
* @param publicKeyMaterial The public key. You must base64 encode the public key material before
* sending it to AWS.
*/
public void setPublicKeyMaterial(String publicKeyMaterial) {
this.publicKeyMaterial = publicKeyMaterial;
}
/**
* The public key. You must base64 encode the public key material before
* sending it to AWS.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param publicKeyMaterial The public key. You must base64 encode the public key material before
* sending it to AWS.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ImportKeyPairRequest withPublicKeyMaterial(String publicKeyMaterial) {
this.publicKeyMaterial = publicKeyMaterial;
return this;
}
/**
* This method is intended for internal use only.
* Returns the marshaled request configured with additional parameters to
* enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new ImportKeyPairRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getKeyName() != null) sb.append("KeyName: " + getKeyName() + ",");
if (getPublicKeyMaterial() != null) sb.append("PublicKeyMaterial: " + getPublicKeyMaterial() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyName() == null) ? 0 : getKeyName().hashCode());
hashCode = prime * hashCode + ((getPublicKeyMaterial() == null) ? 0 : getPublicKeyMaterial().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof ImportKeyPairRequest == false) return false;
ImportKeyPairRequest other = (ImportKeyPairRequest)obj;
if (other.getKeyName() == null ^ this.getKeyName() == null) return false;
if (other.getKeyName() != null && other.getKeyName().equals(this.getKeyName()) == false) return false;
if (other.getPublicKeyMaterial() == null ^ this.getPublicKeyMaterial() == null) return false;
if (other.getPublicKeyMaterial() != null && other.getPublicKeyMaterial().equals(this.getPublicKeyMaterial()) == false) return false;
return true;
}
@Override
public ImportKeyPairRequest clone() {
return (ImportKeyPairRequest) super.clone();
}
}