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)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :password_data,
  :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)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

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

#instance_nameString

The name of this Amazon Lightsail instance.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

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

#ip_addressString

The public IP address of the Amazon Lightsail instance.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

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

#passwordString

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)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

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

#password_dataTypes::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:



3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :password_data,
  :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)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

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

#protocolString

The protocol for these Amazon Lightsail instance access details.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

class InstanceAccessDetails < Struct.new(
  :cert_key,
  :expires_at,
  :ip_address,
  :password,
  :password_data,
  :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)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3100

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