Package software.amazon.awssdk.services.lightsail.model

Interface InstanceAccessDetails.Builder

    • Method Detail

      • certKey

        InstanceAccessDetails.Builder certKey​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expiresAt

        InstanceAccessDetails.Builder expiresAt​(Instant expiresAt)

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

        Parameters:
        expiresAt - For SSH access, the date on which the temporary keys expire.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipAddress

        InstanceAccessDetails.Builder ipAddress​(String ipAddress)

        The public IP address of the Amazon Lightsail instance.

        Parameters:
        ipAddress - The public IP address of the Amazon Lightsail instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipv6Addresses

        InstanceAccessDetails.Builder ipv6Addresses​(Collection<String> ipv6Addresses)

        The IPv6 address of the Amazon Lightsail instance.

        Parameters:
        ipv6Addresses - The IPv6 address of the Amazon Lightsail instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipv6Addresses

        InstanceAccessDetails.Builder ipv6Addresses​(String... ipv6Addresses)

        The IPv6 address of the Amazon Lightsail instance.

        Parameters:
        ipv6Addresses - The IPv6 address of the Amazon Lightsail instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • password

        InstanceAccessDetails.Builder password​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • passwordData

        InstanceAccessDetails.Builder passwordData​(PasswordData 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • privateKey

        InstanceAccessDetails.Builder privateKey​(String privateKey)

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

        Parameters:
        privateKey - For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to tempkey).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceName

        InstanceAccessDetails.Builder instanceName​(String instanceName)

        The name of this Amazon Lightsail instance.

        Parameters:
        instanceName - The name of this Amazon Lightsail instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • username

        InstanceAccessDetails.Builder username​(String username)

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

        Parameters:
        username - The user name to use when logging in to the Amazon Lightsail instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hostKeys

        InstanceAccessDetails.Builder hostKeys​(Collection<HostKeyAttributes> hostKeys)

        Describes the public SSH host keys or the RDP certificate.

        Parameters:
        hostKeys - Describes the public SSH host keys or the RDP certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hostKeys

        InstanceAccessDetails.Builder hostKeys​(HostKeyAttributes... hostKeys)

        Describes the public SSH host keys or the RDP certificate.

        Parameters:
        hostKeys - Describes the public SSH host keys or the RDP certificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.