InstanceAccessDetails (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InstanceAccessDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The parameters for gaining temporary access to one of your Amazon Lightsail instances.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstanceAccessDetails()

Constructors
Constructor and Description
`InstanceAccessDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstanceAccessDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCertKey()` 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`.
`Date`	`getExpiresAt()` For SSH access, the date on which the temporary keys expire.
`String`	`getInstanceName()` The name of this Amazon Lightsail instance.
`String`	`getIpAddress()` The public IP address of the Amazon Lightsail instance.
`String`	`getPassword()` For RDP access, the password for your Amazon Lightsail instance.
`PasswordData`	`getPasswordData()` For a Windows Server-based instance, an object with the data you can use to retrieve your password.
`String`	`getPrivateKey()` For SSH access, the temporary private key.
`String`	`getProtocol()` The protocol for these Amazon Lightsail instance access details.
`String`	`getUsername()` The user name to use when logging in to the Amazon Lightsail instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCertKey(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`.
`void`	`setExpiresAt(Date expiresAt)` For SSH access, the date on which the temporary keys expire.
`void`	`setInstanceName(String instanceName)` The name of this Amazon Lightsail instance.
`void`	`setIpAddress(String ipAddress)` The public IP address of the Amazon Lightsail instance.
`void`	`setPassword(String password)` For RDP access, the password for your Amazon Lightsail instance.
`void`	`setPasswordData(PasswordData passwordData)` For a Windows Server-based instance, an object with the data you can use to retrieve your password.
`void`	`setPrivateKey(String privateKey)` For SSH access, the temporary private key.
`void`	`setProtocol(InstanceAccessProtocol protocol)` The protocol for these Amazon Lightsail instance access details.
`void`	`setProtocol(String protocol)` The protocol for these Amazon Lightsail instance access details.
`void`	`setUsername(String username)` The user name to use when logging in to the Amazon Lightsail instance.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InstanceAccessDetails`	`withCertKey(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`.
`InstanceAccessDetails`	`withExpiresAt(Date expiresAt)` For SSH access, the date on which the temporary keys expire.
`InstanceAccessDetails`	`withInstanceName(String instanceName)` The name of this Amazon Lightsail instance.
`InstanceAccessDetails`	`withIpAddress(String ipAddress)` The public IP address of the Amazon Lightsail instance.
`InstanceAccessDetails`	`withPassword(String password)` For RDP access, the password for your Amazon Lightsail instance.
`InstanceAccessDetails`	`withPasswordData(PasswordData passwordData)` For a Windows Server-based instance, an object with the data you can use to retrieve your password.
`InstanceAccessDetails`	`withPrivateKey(String privateKey)` For SSH access, the temporary private key.
`InstanceAccessDetails`	`withProtocol(InstanceAccessProtocol protocol)` The protocol for these Amazon Lightsail instance access details.
`InstanceAccessDetails`	`withProtocol(String protocol)` The protocol for these Amazon Lightsail instance access details.
`InstanceAccessDetails`	`withUsername(String username)` The user name to use when logging in to the Amazon Lightsail instance.

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

- Constructor Detail
  - InstanceAccessDetails
```
public InstanceAccessDetails()
```
- Method Detail
  - setCertKey
```
public void setCertKey(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.
    
    Parameters:
    
    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.
  - getCertKey
```
public String getCertKey()
```
    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.
  - withCertKey
```
public InstanceAccessDetails withCertKey(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpiresAt
```
public void setExpiresAt(Date expiresAt)
```
    For SSH access, the date on which the temporary keys expire.
    
    Parameters:
    
    expiresAt - For SSH access, the date on which the temporary keys expire.
  - getExpiresAt
```
public Date getExpiresAt()
```
    For SSH access, the date on which the temporary keys expire.
    
    Returns:
    
    For SSH access, the date on which the temporary keys expire.
  - withExpiresAt
```
public InstanceAccessDetails withExpiresAt(Date expiresAt)
```
    For SSH access, the date on which the temporary keys expire.
    
    Parameters:
    
    expiresAt - For SSH access, the date on which the temporary keys expire.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    The public IP address of the Amazon Lightsail instance.
    
    Parameters:
    
    ipAddress - The public IP address of the Amazon Lightsail instance.
  - getIpAddress
```
public String getIpAddress()
```
    The public IP address of the Amazon Lightsail instance.
    
    Returns:
    
    The public IP address of the Amazon Lightsail instance.
  - withIpAddress
```
public InstanceAccessDetails withIpAddress(String ipAddress)
```
    The public IP address of the Amazon Lightsail instance.
    
    Parameters:
    
    ipAddress - The public IP address of the Amazon Lightsail instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(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.
    
    Parameters:
    
    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.
  - getPassword
```
public String getPassword()
```
    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.
  - withPassword
```
public InstanceAccessDetails withPassword(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPasswordData
```
public void setPasswordData(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.
    
    Parameters:
    
    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.
  - getPasswordData
```
public PasswordData getPasswordData()
```
    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.
  - withPasswordData
```
public InstanceAccessDetails withPasswordData(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrivateKey
```
public void setPrivateKey(String privateKey)
```
    For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).
    
    Parameters:
    
    privateKey - For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).
  - getPrivateKey
```
public String getPrivateKey()
```
    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).
  - withPrivateKey
```
public InstanceAccessDetails withPrivateKey(String privateKey)
```
    For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).
    
    Parameters:
    
    privateKey - For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The protocol for these Amazon Lightsail instance access details.
    
    Parameters:
    
    protocol - The protocol for these Amazon Lightsail instance access details.
    
    See Also:
    
    InstanceAccessProtocol
  - getProtocol
```
public String getProtocol()
```
    The protocol for these Amazon Lightsail instance access details.
    
    Returns:
    
    The protocol for these Amazon Lightsail instance access details.
    
    See Also:
    
    InstanceAccessProtocol
  - withProtocol
```
public InstanceAccessDetails withProtocol(String protocol)
```
    The protocol for these Amazon Lightsail instance access details.
    
    Parameters:
    
    protocol - The protocol for these Amazon Lightsail instance access details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceAccessProtocol
  - setProtocol
```
public void setProtocol(InstanceAccessProtocol protocol)
```
    The protocol for these Amazon Lightsail instance access details.
    
    Parameters:
    
    protocol - The protocol for these Amazon Lightsail instance access details.
    
    See Also:
    
    InstanceAccessProtocol
  - withProtocol
```
public InstanceAccessDetails withProtocol(InstanceAccessProtocol protocol)
```
    The protocol for these Amazon Lightsail instance access details.
    
    Parameters:
    
    protocol - The protocol for these Amazon Lightsail instance access details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceAccessProtocol
  - setInstanceName
```
public void setInstanceName(String instanceName)
```
    The name of this Amazon Lightsail instance.
    
    Parameters:
    
    instanceName - The name of this Amazon Lightsail instance.
  - getInstanceName
```
public String getInstanceName()
```
    The name of this Amazon Lightsail instance.
    
    Returns:
    
    The name of this Amazon Lightsail instance.
  - withInstanceName
```
public InstanceAccessDetails withInstanceName(String instanceName)
```
    The name of this Amazon Lightsail instance.
    
    Parameters:
    
    instanceName - The name of this Amazon Lightsail instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    The user name to use when logging in to the Amazon Lightsail instance.
    
    Parameters:
    
    username - The user name to use when logging in to the Amazon Lightsail instance.
  - getUsername
```
public String getUsername()
```
    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.
  - withUsername
```
public InstanceAccessDetails withUsername(String username)
```
    The user name to use when logging in to the Amazon Lightsail instance.
    
    Parameters:
    
    username - The user name to use when logging in to the Amazon Lightsail instance.
    
    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; useful for testing and debugging.
    
    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 InstanceAccessDetails 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 InstanceAccessDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstanceAccessDetails

Method Detail

setCertKey

getCertKey

withCertKey

setExpiresAt

getExpiresAt

withExpiresAt

setIpAddress

getIpAddress

withIpAddress

setPassword

getPassword

withPassword

setPasswordData

getPasswordData

withPasswordData

setPrivateKey

getPrivateKey

withPrivateKey

setProtocol

getProtocol

withProtocol

setProtocol

withProtocol

setInstanceName

getInstanceName

withInstanceName

setUsername

getUsername

withUsername

toString

equals

hashCode

clone

marshall