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 temporary password of the Amazon EC2 instance.

Type: String

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: