software.amazon.awssdk.services.lightsail.model

Class InstanceAccessDetails

java.lang.Object

software.amazon.awssdk.services.lightsail.model.InstanceAccessDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceAccessDetails.Builder,InstanceAccessDetails>

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

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceAccessDetails.Builder

Method Summary

Modifier and Type	Method and Description
static InstanceAccessDetails.Builder	builder()
String	certKey() For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expiresAt() For SSH access, the date on which the temporary keys expire.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHostKeys() For responses, this returns true if the service returned a value for the HostKeys property.
List<HostKeyAttributes>	hostKeys() Describes the public SSH host keys or the RDP certificate.
String	instanceName() The name of this Amazon Lightsail instance.
String	ipAddress() The public IP address of the Amazon Lightsail instance.
String	password() For RDP access, the password for your Amazon Lightsail instance.
PasswordData	passwordData() For a Windows Server-based instance, an object with the data you can use to retrieve your password.
String	privateKey() For SSH access, the temporary private key.
InstanceAccessProtocol	protocol() The protocol for these Amazon Lightsail instance access details.
String	protocolAsString() The protocol for these Amazon Lightsail instance access details.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceAccessDetails.Builder>	serializableBuilderClass()
InstanceAccessDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	username() The user name to use when logging in to the Amazon Lightsail instance.

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

certKey

public final String certKey()

For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.

Returns:

For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.

expiresAt

public final Instant expiresAt()

For SSH access, the date on which the temporary keys expire.

Returns:

For SSH access, the date on which the temporary keys expire.

ipAddress

public final String ipAddress()

The public IP address of the Amazon Lightsail instance.

Returns:

The public IP address of the Amazon Lightsail instance.

password

public final String password()

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string.

If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

Returns:

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you create an instance using any key pair other than the default (LightsailDefaultKeyPair ), password will always be an empty string.

If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

passwordData

public final PasswordData passwordData()

For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.

Returns:

For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.

privateKey

public final String privateKey()

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

Returns:

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

protocol

public final InstanceAccessProtocol protocol()

The protocol for these Amazon Lightsail instance access details.

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

Returns:

The protocol for these Amazon Lightsail instance access details.

See Also:

InstanceAccessProtocol

protocolAsString

public final String protocolAsString()

The protocol for these Amazon Lightsail instance access details.

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

Returns:

The protocol for these Amazon Lightsail instance access details.

See Also:

InstanceAccessProtocol

instanceName

public final String instanceName()

The name of this Amazon Lightsail instance.

Returns:

The name of this Amazon Lightsail instance.

username

public final String username()

The user name to use when logging in to the Amazon Lightsail instance.

Returns:

The user name to use when logging in to the Amazon Lightsail instance.

hasHostKeys

public final boolean hasHostKeys()

For responses, this returns true if the service returned a value for the HostKeys 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.

hostKeys

public final List<HostKeyAttributes> hostKeys()

Describes the public SSH host keys or the RDP certificate.

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 hasHostKeys() method.

Returns:

Describes the public SSH host keys or the RDP certificate.

toBuilder

public InstanceAccessDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceAccessDetails.Builder,InstanceAccessDetails>

builder

public static InstanceAccessDetails.Builder builder()

serializableBuilderClass

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