AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

InstanceAccessDetails

import "github.com/aws/aws-sdk-go/service/lightsail"

type InstanceAccessDetails struct { CertKey *string `locationName:"certKey" type:"string"` ExpiresAt *time.Time `locationName:"expiresAt" type:"timestamp"` InstanceName *string `locationName:"instanceName" type:"string"` IpAddress *string `locationName:"ipAddress" type:"string"` Password *string `locationName:"password" type:"string"` PasswordData *PasswordData `locationName:"passwordData" type:"structure"` PrivateKey *string `locationName:"privateKey" type:"string"` Protocol *string `locationName:"protocol" type:"string" enum:"InstanceAccessProtocol"` Username *string `locationName:"username" type:"string"` }

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

CertKey

Type: *string

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.

ExpiresAt

Type: *time.Time

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

InstanceName

Type: *string

The name of this Amazon Lightsail instance.

IpAddress

Type: *string

The public IP address of the Amazon Lightsail instance.

Password

Type: *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.

PasswordData

The password data for the Windows Server-based instance, including the ciphertext and the key pair name.

PrivateKey

Type: *string

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

Protocol

Type: *string

The protocol for these Amazon Lightsail instance access details.

Username

Type: *string

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

Method

GoString

func (s InstanceAccessDetails) GoString() string

GoString returns the string representation

SetCertKey

func (s *InstanceAccessDetails) SetCertKey(v string) *InstanceAccessDetails

SetCertKey sets the CertKey field's value.

SetExpiresAt

func (s *InstanceAccessDetails) SetExpiresAt(v time.Time) *InstanceAccessDetails

SetExpiresAt sets the ExpiresAt field's value.

SetInstanceName

func (s *InstanceAccessDetails) SetInstanceName(v string) *InstanceAccessDetails

SetInstanceName sets the InstanceName field's value.

SetIpAddress

func (s *InstanceAccessDetails) SetIpAddress(v string) *InstanceAccessDetails

SetIpAddress sets the IpAddress field's value.

SetPassword

func (s *InstanceAccessDetails) SetPassword(v string) *InstanceAccessDetails

SetPassword sets the Password field's value.

SetPasswordData

func (s *InstanceAccessDetails) SetPasswordData(v *PasswordData) *InstanceAccessDetails

SetPasswordData sets the PasswordData field's value.

SetPrivateKey

func (s *InstanceAccessDetails) SetPrivateKey(v string) *InstanceAccessDetails

SetPrivateKey sets the PrivateKey field's value.

SetProtocol

func (s *InstanceAccessDetails) SetProtocol(v string) *InstanceAccessDetails

SetProtocol sets the Protocol field's value.

SetUsername

func (s *InstanceAccessDetails) SetUsername(v string) *InstanceAccessDetails

SetUsername sets the Username field's value.

String

func (s InstanceAccessDetails) String() string

String returns the string representation

On this page: