Class SshPublicKey

java.lang.Object
software.amazon.awssdk.services.transfer.model.SshPublicKey
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SshPublicKey.Builder,SshPublicKey>
@Generated("software.amazon.awssdk:codegen") public final class SshPublicKey extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SshPublicKey.Builder,SshPublicKey>

Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

See Also:

  • Method Details

    • dateImported

      public final Instant dateImported()

      Specifies the date that the public key was added to the Transfer Family user.

      Returns:
      Specifies the date that the public key was added to the Transfer Family user.

    • sshPublicKeyBody

      public final String sshPublicKeyBody()

      Specifies the content of the SSH public key as specified by the PublicKeyId.

      Transfer Family accepts RSA, ECDSA, and ED25519 keys.

      Returns:
      Specifies the content of the SSH public key as specified by the PublicKeyId.

      Transfer Family accepts RSA, ECDSA, and ED25519 keys.

    • sshPublicKeyId

      public final String sshPublicKeyId()

      Specifies the SshPublicKeyId parameter contains the identifier of the public key.

      Returns:
      Specifies the SshPublicKeyId parameter contains the identifier of the public key.

    • toBuilder

      public SshPublicKey.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<SshPublicKey.Builder,SshPublicKey>
      Returns:
      a builder for type T

    • builder

      public static SshPublicKey.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SshPublicKey.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.