Skip to content

InstanceAccessDetails

Source code in docs_src/capo_lightsail/types/instance_access_details.py
class InstanceAccessDetails(TypedDict, closed=True):
    cert_key: NotRequired["capo_lightsail.types.string.string"]
    """<p>For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you should save this value to <code>tempkey-cert.pub</code>.</p>"""
    expires_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>For SSH access, the date on which the temporary keys expire.</p>"""
    ip_address: NotRequired["capo_lightsail.types.ip_address.IpAddress"]
    """<p>The public IP address of the Amazon Lightsail instance.</p>"""
    ipv6_addresses: NotRequired[
        "capo_lightsail.types.ipv6_address_list.Ipv6AddressList"
    ]
    """<p>The IPv6 address of the Amazon Lightsail instance.</p>"""
    password: NotRequired["capo_lightsail.types.string.string"]
    """<p>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.</p> <note> <p>If you create an instance using any key pair other than the default (<code>LightsailDefaultKeyPair</code>), <code>password</code> will always be an empty string.</p> <p>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.</p> </note>"""
    password_data: NotRequired["capo_lightsail.types.password_data.PasswordData"]
    """<p>For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if <code>password</code> 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.</p>"""
    private_key: NotRequired["capo_lightsail.types.string.string"]
    """<p>For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to <code>tempkey</code>).</p>"""
    protocol: NotRequired[
        "capo_lightsail.types.instance_access_protocol.InstanceAccessProtocol"
    ]
    """<p>The protocol for these Amazon Lightsail instance access details.</p>"""
    instance_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of this Amazon Lightsail instance.</p>"""
    username: NotRequired["capo_lightsail.types.string.string"]
    """<p>The user name to use when logging in to the Amazon Lightsail instance.</p>"""
    host_keys: NotRequired["capo_lightsail.types.host_keys_list.HostKeysList"]
    """<p>Describes the public SSH host keys or the RDP certificate.</p>"""

cert_key instance-attribute

cert_key: NotRequired[string]

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.

expires_at instance-attribute

expires_at: NotRequired[IsoDate]

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

host_keys instance-attribute

host_keys: NotRequired[HostKeysList]

Describes the public SSH host keys or the RDP certificate.

instance_name instance-attribute

instance_name: NotRequired[ResourceName]

The name of this Amazon Lightsail instance.

ip_address instance-attribute

ip_address: NotRequired[IpAddress]

The public IP address of the Amazon Lightsail instance.

ipv6_addresses instance-attribute

ipv6_addresses: NotRequired[Ipv6AddressList]

The IPv6 address of the Amazon Lightsail instance.

password instance-attribute

password: NotRequired[string]

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.

password_data instance-attribute

password_data: NotRequired[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.

private_key instance-attribute

private_key: NotRequired[string]

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

protocol instance-attribute

protocol: NotRequired[InstanceAccessProtocol]

The protocol for these Amazon Lightsail instance access details.

username instance-attribute

username: NotRequired[string]

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