KeyPair (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.KeyPair

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KeyPair
extends Object
implements Serializable, Cloneable

Describes a key pair.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeyPair()

Constructors
Constructor and Description
`KeyPair()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyPair`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKeyFingerprint()`
`String`	`getKeyMaterial()` An unencrypted PEM encoded RSA or ED25519 private key.
`String`	`getKeyName()` The name of the key pair.
`String`	`getKeyPairId()` The ID of the key pair.
`List<Tag>`	`getTags()` Any tags applied to the key pair.
`int`	`hashCode()`
`void`	`setKeyFingerprint(String keyFingerprint)`
`void`	`setKeyMaterial(String keyMaterial)` An unencrypted PEM encoded RSA or ED25519 private key.
`void`	`setKeyName(String keyName)` The name of the key pair.
`void`	`setKeyPairId(String keyPairId)` The ID of the key pair.
`void`	`setTags(Collection<Tag> tags)` Any tags applied to the key pair.
`String`	`toString()` Returns a string representation of this object.
`KeyPair`	`withKeyFingerprint(String keyFingerprint)`
`KeyPair`	`withKeyMaterial(String keyMaterial)` An unencrypted PEM encoded RSA or ED25519 private key.
`KeyPair`	`withKeyName(String keyName)` The name of the key pair.
`KeyPair`	`withKeyPairId(String keyPairId)` The ID of the key pair.
`KeyPair`	`withTags(Collection<Tag> tags)` Any tags applied to the key pair.
`KeyPair`	`withTags(Tag... tags)` Any tags applied to the key pair.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeyPair
```
public KeyPair()
```
- Method Detail
  - setKeyFingerprint
```
public void setKeyFingerprint(String keyFingerprint)
```
    - For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
    - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
    Parameters:
    
    keyFingerprint -
    
    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
    
    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
  - getKeyFingerprint
```
public String getKeyFingerprint()
```
    - For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
    - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
    Returns:
    
    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
    
    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
  - withKeyFingerprint
```
public KeyPair withKeyFingerprint(String keyFingerprint)
```
    - For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
    - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
    Parameters:
    
    keyFingerprint -
    
    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
    
    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyMaterial
```
public void setKeyMaterial(String keyMaterial)
```
    An unencrypted PEM encoded RSA or ED25519 private key.
    
    Parameters:
    
    keyMaterial - An unencrypted PEM encoded RSA or ED25519 private key.
  - getKeyMaterial
```
public String getKeyMaterial()
```
    An unencrypted PEM encoded RSA or ED25519 private key.
    
    Returns:
    
    An unencrypted PEM encoded RSA or ED25519 private key.
  - withKeyMaterial
```
public KeyPair withKeyMaterial(String keyMaterial)
```
    An unencrypted PEM encoded RSA or ED25519 private key.
    
    Parameters:
    
    keyMaterial - An unencrypted PEM encoded RSA or ED25519 private key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyName
```
public void setKeyName(String keyName)
```
    The name of the key pair.
    
    Parameters:
    
    keyName - The name of the key pair.
  - getKeyName
```
public String getKeyName()
```
    The name of the key pair.
    
    Returns:
    
    The name of the key pair.
  - withKeyName
```
public KeyPair withKeyName(String keyName)
```
    The name of the key pair.
    
    Parameters:
    
    keyName - The name of the key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyPairId
```
public void setKeyPairId(String keyPairId)
```
    The ID of the key pair.
    
    Parameters:
    
    keyPairId - The ID of the key pair.
  - getKeyPairId
```
public String getKeyPairId()
```
    The ID of the key pair.
    
    Returns:
    
    The ID of the key pair.
  - withKeyPairId
```
public KeyPair withKeyPairId(String keyPairId)
```
    The ID of the key pair.
    
    Parameters:
    
    keyPairId - The ID of the key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Any tags applied to the key pair.
    
    Returns:
    
    Any tags applied to the key pair.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Any tags applied to the key pair.
    
    Parameters:
    
    tags - Any tags applied to the key pair.
  - withTags
```
public KeyPair withTags(Tag... tags)
```
    Any tags applied to the key pair.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Any tags applied to the key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public KeyPair withTags(Collection<Tag> tags)
```
    Any tags applied to the key pair.
    
    Parameters:
    
    tags - Any tags applied to the key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public KeyPair clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.778

Class KeyPair

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyPair

Method Detail

setKeyFingerprint

getKeyFingerprint

withKeyFingerprint

setKeyMaterial

getKeyMaterial

withKeyMaterial

setKeyName

getKeyName

withKeyName

setKeyPairId

getKeyPairId

withKeyPairId

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone