KeyPair (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.KeyPair

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KeyPair
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes an SSH key pair.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeyPair()

Constructors
Constructor and Description
`KeyPair()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyPair`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the key pair (e.g., `arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`).
`Date`	`getCreatedAt()` The timestamp when the key pair was created (e.g., `1479816991.349`).
`String`	`getFingerprint()` The RSA fingerprint of the key pair.
`ResourceLocation`	`getLocation()` The region name and Availability Zone where the key pair was created.
`String`	`getName()` The friendly name of the SSH key pair.
`String`	`getResourceType()` The resource type (usually `KeyPair`).
`String`	`getSupportCode()` The support code.
`List<Tag>`	`getTags()` The tag keys and optional values for the resource.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the key pair (e.g., `arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`).
`void`	`setCreatedAt(Date createdAt)` The timestamp when the key pair was created (e.g., `1479816991.349`).
`void`	`setFingerprint(String fingerprint)` The RSA fingerprint of the key pair.
`void`	`setLocation(ResourceLocation location)` The region name and Availability Zone where the key pair was created.
`void`	`setName(String name)` The friendly name of the SSH key pair.
`void`	`setResourceType(ResourceType resourceType)` The resource type (usually `KeyPair`).
`void`	`setResourceType(String resourceType)` The resource type (usually `KeyPair`).
`void`	`setSupportCode(String supportCode)` The support code.
`void`	`setTags(Collection<Tag> tags)` The tag keys and optional values for the resource.
`String`	`toString()` Returns a string representation of this object.
`KeyPair`	`withArn(String arn)` The Amazon Resource Name (ARN) of the key pair (e.g., `arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`).
`KeyPair`	`withCreatedAt(Date createdAt)` The timestamp when the key pair was created (e.g., `1479816991.349`).
`KeyPair`	`withFingerprint(String fingerprint)` The RSA fingerprint of the key pair.
`KeyPair`	`withLocation(ResourceLocation location)` The region name and Availability Zone where the key pair was created.
`KeyPair`	`withName(String name)` The friendly name of the SSH key pair.
`KeyPair`	`withResourceType(ResourceType resourceType)` The resource type (usually `KeyPair`).
`KeyPair`	`withResourceType(String resourceType)` The resource type (usually `KeyPair`).
`KeyPair`	`withSupportCode(String supportCode)` The support code.
`KeyPair`	`withTags(Collection<Tag> tags)` The tag keys and optional values for the resource.
`KeyPair`	`withTags(Tag... tags)` The tag keys and optional values for the resource.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeyPair
```
public KeyPair()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The friendly name of the SSH key pair.
    
    Parameters:
    
    name - The friendly name of the SSH key pair.
  - getName
```
public String getName()
```
    The friendly name of the SSH key pair.
    
    Returns:
    
    The friendly name of the SSH key pair.
  - withName
```
public KeyPair withName(String name)
```
    The friendly name of the SSH key pair.
    
    Parameters:
    
    name - The friendly name of the SSH key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
    
    Returns:
    
    The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
  - withArn
```
public KeyPair withArn(String arn)
```
    The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSupportCode
```
public void setSupportCode(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.
    
    Parameters:
    
    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.
  - getSupportCode
```
public String getSupportCode()
```
    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.
  - withSupportCode
```
public KeyPair withSupportCode(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The timestamp when the key pair was created (e.g., 1479816991.349).
    
    Parameters:
    
    createdAt - The timestamp when the key pair was created (e.g., 1479816991.349).
  - getCreatedAt
```
public Date getCreatedAt()
```
    The timestamp when the key pair was created (e.g., 1479816991.349).
    
    Returns:
    
    The timestamp when the key pair was created (e.g., 1479816991.349).
  - withCreatedAt
```
public KeyPair withCreatedAt(Date createdAt)
```
    The timestamp when the key pair was created (e.g., 1479816991.349).
    
    Parameters:
    
    createdAt - The timestamp when the key pair was created (e.g., 1479816991.349).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(ResourceLocation location)
```
    The region name and Availability Zone where the key pair was created.
    
    Parameters:
    
    location - The region name and Availability Zone where the key pair was created.
  - getLocation
```
public ResourceLocation getLocation()
```
    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.
  - withLocation
```
public KeyPair withLocation(ResourceLocation location)
```
    The region name and Availability Zone where the key pair was created.
    
    Parameters:
    
    location - The region name and Availability Zone where the key pair was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The resource type (usually KeyPair).
    
    Parameters:
    
    resourceType - The resource type (usually KeyPair).
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The resource type (usually KeyPair).
    
    Returns:
    
    The resource type (usually KeyPair).
    
    See Also:
    
    ResourceType
  - withResourceType
```
public KeyPair withResourceType(String resourceType)
```
    The resource type (usually KeyPair).
    
    Parameters:
    
    resourceType - The resource type (usually KeyPair).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setResourceType
```
public void setResourceType(ResourceType resourceType)
```
    The resource type (usually KeyPair).
    
    Parameters:
    
    resourceType - The resource type (usually KeyPair).
    
    See Also:
    
    ResourceType
  - withResourceType
```
public KeyPair withResourceType(ResourceType resourceType)
```
    The resource type (usually KeyPair).
    
    Parameters:
    
    resourceType - The resource type (usually KeyPair).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - getTags
```
public List<Tag> getTags()
```
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    Returns:
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    Parameters:
    
    tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
  - withTags
```
public KeyPair withTags(Tag... tags)
```
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public KeyPair withTags(Collection<Tag> tags)
```
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    Parameters:
    
    tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFingerprint
```
public void setFingerprint(String fingerprint)
```
    The RSA fingerprint of the key pair.
    
    Parameters:
    
    fingerprint - The RSA fingerprint of the key pair.
  - getFingerprint
```
public String getFingerprint()
```
    The RSA fingerprint of the key pair.
    
    Returns:
    
    The RSA fingerprint of the key pair.
  - withFingerprint
```
public KeyPair withFingerprint(String fingerprint)
```
    The RSA fingerprint of the key pair.
    
    Parameters:
    
    fingerprint - The RSA fingerprint of the key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public KeyPair clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class KeyPair

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyPair

Method Detail

setName

getName

withName

setArn

getArn

withArn

setSupportCode

getSupportCode

withSupportCode

setCreatedAt

getCreatedAt

withCreatedAt

setLocation

getLocation

withLocation

setResourceType

getResourceType

withResourceType

setResourceType

withResourceType

getTags

setTags

withTags

withTags

setFingerprint

getFingerprint

withFingerprint

toString

equals

hashCode

clone

marshall