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:
  • Method Details

    • 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 return KeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

      Returns:
      The type of key pair.
      See Also:
    • 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 return KeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

      Returns:
      The type of key pair.
      See Also:
    • 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 the isEmpty() 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<KeyPairInfo.Builder,KeyPairInfo>
      Returns:
      a builder for type T
    • builder

      public static KeyPairInfo.Builder builder()
    • serializableBuilderClass

      public static Class<? extends KeyPairInfo.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.