Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

InstanceAccessDetails

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

Contents

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.

Type: String

Required: No

expiresAt

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

Type: Timestamp

Required: No

instanceName

The name of this Amazon Lightsail instance.

Type: String

Pattern: \w[\w\-]*\w

Required: No

ipAddress

The public IP address of the Amazon Lightsail instance.

Type: String

Pattern: ([0-9]{1,3}\.){3}[0-9]{1,3}

Required: No

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.

Note

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.

Type: String

Required: No

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.

Type: PasswordData object

Required: No

privateKey

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

Type: String

Required: No

protocol

The protocol for these Amazon Lightsail instance access details.

Type: String

Valid Values: ssh | rdp

Required: No

username

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: