You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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.

Instance Attribute Summary collapse

Instance Attribute Details

#cert_keyString

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.

Returns:

  • (String)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end

#expires_atTime

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

Returns:

  • (Time)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end

#instance_nameString

The name of this Amazon Lightsail instance.

Returns:

  • (String)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end

#ip_addressString

The public IP address of the Amazon Lightsail instance.

Returns:

  • (String)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end

#passwordString

For RDP access, the temporary password of the Amazon EC2 instance.

Returns:

  • (String)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end

#private_keyString

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

Returns:

  • (String)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end

#protocolString

The protocol for these Amazon Lightsail instance access details.

Returns:

  • (String)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1968

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :private_key,
  :protocol,
  :instance_name,
  :username)
  include Aws::Structure
end