Class: Aws::Lightsail::Types::InstanceAccessDetails

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::InstanceAccessDetails

Defined in:

gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cert_key ⇒ 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 ⇒ Time

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

• #host_keys ⇒ Array<Types::HostKeyAttributes>

  Describes the public SSH host keys or the RDP certificate.

• #instance_name ⇒ String

  The name of this Amazon Lightsail instance.

• #ip_address ⇒ String

  The public IP address of the Amazon Lightsail instance.

• #ipv6_addresses ⇒ Array<String>

  The IPv6 address of the Amazon Lightsail instance.

• #password ⇒ String

  For RDP access, the password for your Amazon Lightsail instance.

• #password_data ⇒ Types::PasswordData

  For a Windows Server-based instance, an object with the data you can use to retrieve your password.

• #private_key ⇒ String

  For SSH access, the temporary private key.

• #protocol ⇒ String

  The protocol for these Amazon Lightsail instance access details.

• #username ⇒ String

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

Instance Attribute Details

#cert_key ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#expires_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#host_keys ⇒ Array<Types::HostKeyAttributes>

Describes the public SSH host keys or the RDP certificate.

Returns:

• (Array<Types::HostKeyAttributes>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#instance_name ⇒ String

The name of this Amazon Lightsail instance.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address ⇒ String

The public IP address of the Amazon Lightsail instance.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#ipv6_addresses ⇒ Array<String>

The IPv6 address of the Amazon Lightsail instance.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#password ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#password_data ⇒ Types::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:

• (Types::PasswordData)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#private_key ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The protocol for these Amazon Lightsail instance access details.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end

#username ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 10046

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :ipv6_addresses,
  :password,
  :password_data,
  :private_key,
  :protocol,
  :instance_name,
  :username,
  :host_keys)
  SENSITIVE = []
  include Aws::Structure
end