/AWS1/CL_LSAINSTACCESSDETAILS

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_certkey TYPE /AWS1/LSASTRING /AWS1/LSASTRING

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

iv_expiresat TYPE /AWS1/LSAISODATE /AWS1/LSAISODATE

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

iv_ipaddress TYPE /AWS1/LSAIPADDRESS /AWS1/LSAIPADDRESS

The public IP address of the Amazon Lightsail instance.

it_ipv6addresses TYPE /AWS1/CL_LSAIPV6ADDRESSLIST_W=>TT_IPV6ADDRESSLIST TT_IPV6ADDRESSLIST

The IPv6 address of the Amazon Lightsail instance.

iv_password TYPE /AWS1/LSASTRING /AWS1/LSASTRING

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.

io_passworddata TYPE REF TO /AWS1/CL_LSAPASSWORDDATA /AWS1/CL_LSAPASSWORDDATA

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.

iv_privatekey TYPE /AWS1/LSASTRING /AWS1/LSASTRING

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

iv_protocol TYPE /AWS1/LSAINSTACCESSPROTOCOL /AWS1/LSAINSTACCESSPROTOCOL

The protocol for these Amazon Lightsail instance access details.

iv_instancename TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of this Amazon Lightsail instance.

iv_username TYPE /AWS1/LSASTRING /AWS1/LSASTRING

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

it_hostkeys TYPE /AWS1/CL_LSAHOSTKEYATTRIBUTES=>TT_HOSTKEYSLIST TT_HOSTKEYSLIST

Describes the public SSH host keys or the RDP certificate.

---

Queryable Attributes

certKey

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

Accessible with the following methods

Method	Description
GET_CERTKEY()	Getter for CERTKEY, with configurable default
ASK_CERTKEY()	Getter for CERTKEY w/ exceptions if field has no value
HAS_CERTKEY()	Determine if CERTKEY has a value

expiresAt

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

Accessible with the following methods

Method	Description
GET_EXPIRESAT()	Getter for EXPIRESAT, with configurable default
ASK_EXPIRESAT()	Getter for EXPIRESAT w/ exceptions if field has no value
HAS_EXPIRESAT()	Determine if EXPIRESAT has a value

ipAddress

The public IP address of the Amazon Lightsail instance.

Accessible with the following methods

Method	Description
GET_IPADDRESS()	Getter for IPADDRESS, with configurable default
ASK_IPADDRESS()	Getter for IPADDRESS w/ exceptions if field has no value
HAS_IPADDRESS()	Determine if IPADDRESS has a value

ipv6Addresses

The IPv6 address of the Amazon Lightsail instance.

Accessible with the following methods

Method	Description
GET_IPV6ADDRESSES()	Getter for IPV6ADDRESSES, with configurable default
ASK_IPV6ADDRESSES()	Getter for IPV6ADDRESSES w/ exceptions if field has no value
HAS_IPV6ADDRESSES()	Determine if IPV6ADDRESSES has a value

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.

Accessible with the following methods

Method	Description
GET_PASSWORD()	Getter for PASSWORD, with configurable default
ASK_PASSWORD()	Getter for PASSWORD w/ exceptions if field has no value
HAS_PASSWORD()	Determine if PASSWORD has a value

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.

Accessible with the following methods

Method	Description
GET_PASSWORDDATA()	Getter for PASSWORDDATA

privateKey

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

Accessible with the following methods

Method	Description
GET_PRIVATEKEY()	Getter for PRIVATEKEY, with configurable default
ASK_PRIVATEKEY()	Getter for PRIVATEKEY w/ exceptions if field has no value
HAS_PRIVATEKEY()	Determine if PRIVATEKEY has a value

protocol

The protocol for these Amazon Lightsail instance access details.

Accessible with the following methods

Method	Description
GET_PROTOCOL()	Getter for PROTOCOL, with configurable default
ASK_PROTOCOL()	Getter for PROTOCOL w/ exceptions if field has no value
HAS_PROTOCOL()	Determine if PROTOCOL has a value

instanceName

The name of this Amazon Lightsail instance.

Accessible with the following methods

Method	Description
GET_INSTANCENAME()	Getter for INSTANCENAME, with configurable default
ASK_INSTANCENAME()	Getter for INSTANCENAME w/ exceptions if field has no value
HAS_INSTANCENAME()	Determine if INSTANCENAME has a value

username

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

Accessible with the following methods

Method	Description
GET_USERNAME()	Getter for USERNAME, with configurable default
ASK_USERNAME()	Getter for USERNAME w/ exceptions if field has no value
HAS_USERNAME()	Determine if USERNAME has a value

hostKeys

Describes the public SSH host keys or the RDP certificate.

Accessible with the following methods

Method	Description
GET_HOSTKEYS()	Getter for HOSTKEYS, with configurable default
ASK_HOSTKEYS()	Getter for HOSTKEYS w/ exceptions if field has no value
HAS_HOSTKEYS()	Determine if HOSTKEYS has a value