java.lang.Object
- software.amazon.awssdk.services.lightsail.model.KeyPair

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<KeyPair.Builder,KeyPair>

@Generated("software.amazon.awssdk:codegen")
public final class KeyPair
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KeyPair.Builder,KeyPair>

Describes an SSH key pair.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface KeyPair.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the key pair ( `arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`).
`static KeyPair.Builder`	`builder()`
`Instant`	`createdAt()`	The timestamp when the key pair was created (`1479816991.349`).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fingerprint()`	The RSA fingerprint of the key pair.
`<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.
`ResourceLocation`	`location()`	The region name and Availability Zone where the key pair was created.
`String`	`name()`	The friendly name of the SSH key pair.
`ResourceType`	`resourceType()`	The resource type (usually `KeyPair`).
`String`	`resourceTypeAsString()`	The resource type (usually `KeyPair`).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KeyPair.Builder>`	`serializableBuilderClass()`
`String`	`supportCode()`	The support code.
`List<Tag>`	`tags()`	The tag keys and optional values for the resource.
`KeyPair.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
  - name
```
public final String name()
```
    The friendly name of the SSH key pair.
    
    Returns:
    
    The friendly name of the SSH key pair.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the key pair ( arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
    
    Returns:
    
    The Amazon Resource Name (ARN) of the key pair ( arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
  - supportCode
```
public final String supportCode()
```
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    
    Returns:
    
    The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
  - createdAt
```
public final Instant createdAt()
```
    The timestamp when the key pair was created (1479816991.349).
    
    Returns:
    
    The timestamp when the key pair was created (1479816991.349).
  - location
```
public final ResourceLocation location()
```
    The region name and Availability Zone where the key pair was created.
    
    Returns:
    
    The region name and Availability Zone where the key pair was created.
  - resourceType
```
public final ResourceType resourceType()
```
    The resource type (usually KeyPair).
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The resource type (usually KeyPair).
    
    See Also:
    
    ResourceType
  - resourceTypeAsString
```
public final String resourceTypeAsString()
```
    The resource type (usually KeyPair).
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The resource type (usually KeyPair).
    
    See Also:
    
    ResourceType
  - 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()
```
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    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:
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
  - fingerprint
```
public final String fingerprint()
```
    The RSA fingerprint of the key pair.
    
    Returns:
    
    The RSA fingerprint of the key pair.
  - toBuilder
```
public KeyPair.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KeyPair.Builder,KeyPair>
  - builder
```
public static KeyPair.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends KeyPair.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

Class KeyPair

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

arn

supportCode

createdAt

location

resourceType

resourceTypeAsString

hasTags

tags

fingerprint

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields