com.amazonaws.services.ec2.model

Class ImportKeyPairRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ImportKeyPairRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<ImportKeyPairRequest>, Serializable, Cloneable

public class ImportKeyPairRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ImportKeyPairRequest>

Container for the parameters to the 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 Also:

AmazonEC2.importKeyPair(ImportKeyPairRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ImportKeyPairRequest() Default constructor for a new ImportKeyPairRequest object.
ImportKeyPairRequest(String keyName, String publicKeyMaterial) Constructs a new ImportKeyPairRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
ImportKeyPairRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<ImportKeyPairRequest>	getDryRunRequest() This method is intended for internal use only.
String	getKeyName() A unique name for the key pair.
String	getPublicKeyMaterial() The public key.
int	hashCode()
void	setKeyName(String keyName) A unique name for the key pair.
void	setPublicKeyMaterial(String publicKeyMaterial) The public key.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ImportKeyPairRequest	withKeyName(String keyName) A unique name for the key pair.
ImportKeyPairRequest	withPublicKeyMaterial(String publicKeyMaterial) The public key.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportKeyPairRequest

public ImportKeyPairRequest()

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

ImportKeyPairRequest

public ImportKeyPairRequest(String keyName,
                    String publicKeyMaterial)

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

Parameters:

keyName - A unique name for the key pair.

publicKeyMaterial - The public key. You must base64 encode the public key material before sending it to AWS.

Method Detail

getKeyName

public String getKeyName()

A unique name for the key pair.

Returns:

A unique name for the key pair.

setKeyName

public void setKeyName(String keyName)

A unique name for the key pair.

Parameters:

keyName - A unique name for the key pair.

withKeyName

public ImportKeyPairRequest withKeyName(String keyName)

A unique name for the key pair.

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

Parameters:

keyName - A unique name for the key pair.

Returns:

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

getPublicKeyMaterial

public String getPublicKeyMaterial()

The public key. You must base64 encode the public key material before sending it to AWS.

Returns:

The public key. You must base64 encode the public key material before sending it to AWS.

setPublicKeyMaterial

public void setPublicKeyMaterial(String publicKeyMaterial)

The public key. You must base64 encode the public key material before sending it to AWS.

Parameters:

publicKeyMaterial - The public key. You must base64 encode the public key material before sending it to AWS.

withPublicKeyMaterial

public ImportKeyPairRequest withPublicKeyMaterial(String 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.

Parameters:

publicKeyMaterial - The public key. You must base64 encode the public key material before sending it to AWS.

Returns:

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

getDryRunRequest

public Request<ImportKeyPairRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<ImportKeyPairRequest>

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 ImportKeyPairRequest 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()