Get Instance Access Details

lightsail_get_instance_access_details

R Documentation

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance

Description

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

The ⁠get instance access details⁠ operation supports tag-based access control via resource tags applied to the resource identified by ⁠instance name⁠. For more information, see the Amazon Lightsail Developer Guide.

Usage

lightsail_get_instance_access_details(instanceName, protocol)

Arguments

instanceName

[required] The name of the instance to access.

protocol

The protocol to use to connect to your instance. Defaults to ssh.

Value

A list with the following syntax:

list(
  accessDetails = list(
    certKey = "string",
    expiresAt = as.POSIXct(
      "2015-01-01"
    ),
    ipAddress = "string",
    ipv6Addresses = list(
      "string"
    ),
    password = "string",
    passwordData = list(
      ciphertext = "string",
      keyPairName = "string"
    ),
    privateKey = "string",
    protocol = "ssh"|"rdp",
    instanceName = "string",
    username = "string",
    hostKeys = list(
      list(
        algorithm = "string",
        publicKey = "string",
        witnessedAt = as.POSIXct(
          "2015-01-01"
        ),
        fingerprintSHA1 = "string",
        fingerprintSHA256 = "string",
        notValidBefore = as.POSIXct(
          "2015-01-01"
        ),
        notValidAfter = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)

Request syntax

svc$get_instance_access_details(
  instanceName = "string",
  protocol = "ssh"|"rdp"
)