Package software.amazon.awssdk.services.iam.model

Class SSHPublicKey

java.lang.Object

software.amazon.awssdk.services.iam.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>

Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SSHPublicKey.Builder

Method Summary

Modifier and Type	Method	Description
static SSHPublicKey.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fingerprint()	The MD5 message digest of the SSH public key.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SSHPublicKey.Builder>	serializableBuilderClass()
String	sshPublicKeyBody()	The SSH public key.
String	sshPublicKeyId()	The unique identifier for the SSH public key.
StatusType	status()	The status of the SSH public key.
String	statusAsString()	The status of the SSH public key.
SSHPublicKey.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	uploadDate()	The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
String	userName()	The name of the IAM user associated with the SSH public key.

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

userName

public final String userName()

The name of the IAM user associated with the SSH public key.

Returns:

The name of the IAM user associated with the SSH public key.

sshPublicKeyId

public final String sshPublicKeyId()

The unique identifier for the SSH public key.

Returns:

The unique identifier for the SSH public key.

fingerprint

public final String fingerprint()

The MD5 message digest of the SSH public key.

Returns:

The MD5 message digest of the SSH public key.

sshPublicKeyBody

public final String sshPublicKeyBody()

The SSH public key.

Returns:

The SSH public key.

status

public final StatusType status()

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

See Also:

StatusType

statusAsString

public final String statusAsString()

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

See Also:

StatusType

uploadDate

public final Instant uploadDate()

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

Returns:

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

toBuilder

public SSHPublicKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SSHPublicKey.Builder,SSHPublicKey>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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