Documentation

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

See: newInstanceAccessDetails smart constructor.

Create a value of InstanceAccessDetails with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hostKeys:InstanceAccessDetails', instanceAccessDetails_hostKeys - Describes the public SSH host keys or the RDP certificate.

$sel:certKey:InstanceAccessDetails', instanceAccessDetails_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.

$sel:ipAddress:InstanceAccessDetails', instanceAccessDetails_ipAddress - The public IP address of the Amazon Lightsail instance.

$sel:privateKey:InstanceAccessDetails', instanceAccessDetails_privateKey - For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

$sel:expiresAt:InstanceAccessDetails', instanceAccessDetails_expiresAt - For SSH access, the date on which the temporary keys expire.

$sel:username:InstanceAccessDetails', instanceAccessDetails_username - The user name to use when logging in to the Amazon Lightsail instance.

$sel:protocol:InstanceAccessDetails', instanceAccessDetails_protocol - The protocol for these Amazon Lightsail instance access details.

$sel:passwordData:InstanceAccessDetails', instanceAccessDetails_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.

$sel:password:InstanceAccessDetails', instanceAccessDetails_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.

$sel:instanceName:InstanceAccessDetails', instanceAccessDetails_instanceName - The name of this Amazon Lightsail instance.

Describes the public SSH host keys or the RDP certificate.

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.

The public IP address of the Amazon Lightsail instance.

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

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

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

The protocol for these Amazon Lightsail instance access details.

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.

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.

The name of this Amazon Lightsail instance.