Class KeyPairInfo
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.KeyPairInfo
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KeyPairInfo.Builder,KeyPairInfo>
@Generated("software.amazon.awssdk:codegen") public final class KeyPairInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KeyPairInfo.Builder,KeyPairInfo>
Describes a key pair.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
KeyPairInfo.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static KeyPairInfo.Builder
builder()
Instant
createTime()
If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
keyFingerprint()
If you used CreateKeyPair to create the key pair:String
keyName()
The name of the key pair.String
keyPairId()
The ID of the key pair.KeyType
keyType()
The type of key pair.String
keyTypeAsString()
The type of key pair.String
publicKey()
The public key material.List<SdkField<?>>
sdkFields()
static Class<? extends KeyPairInfo.Builder>
serializableBuilderClass()
List<Tag>
tags()
Any tags applied to the key pair.KeyPairInfo.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
keyPairId
public final String keyPairId()
The ID of the key pair.
- Returns:
- The ID of the key pair.
-
keyFingerprint
public final String keyFingerprint()
If you used CreateKeyPair to create the key pair:
-
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.
If you used ImportKeyPair to provide Amazon Web Services the public key:
-
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
-
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:
- If you used CreateKeyPair to create the key pair:
-
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.
If you used ImportKeyPair to provide Amazon Web Services the public key:
-
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
-
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.
-
-
-
keyName
public final String keyName()
The name of the key pair.
- Returns:
- The name of the key pair.
-
keyType
public final KeyType keyType()
The type of key pair.
If the service returns an enum value that is not available in the current SDK version,
keyType
will returnKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- Returns:
- The type of key pair.
- See Also:
KeyType
-
keyTypeAsString
public final String keyTypeAsString()
The type of key pair.
If the service returns an enum value that is not available in the current SDK version,
keyType
will returnKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- Returns:
- The type of key pair.
- See Also:
KeyType
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
Any tags applied to the key pair.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Any tags applied to the key pair.
-
publicKey
public final String publicKey()
The public key material.
- Returns:
- The public key material.
-
createTime
public final Instant createTime()
If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
- Returns:
- If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC
time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
-
toBuilder
public KeyPairInfo.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<KeyPairInfo.Builder,KeyPairInfo>
-
builder
public static KeyPairInfo.Builder builder()
-
serializableBuilderClass
public static Class<? extends KeyPairInfo.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
-