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

Class: Aws::Lightsail::Types::PasswordData

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertextString

The encrypted password. Ciphertext will be an empty string if access to 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 use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field.

If you are using a custom key pair, you need to use your own means of decryption.

If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

Returns:

  • (String)


4009
4010
4011
4012
4013
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4009

class PasswordData < Struct.new(
  :ciphertext,
  :key_pair_name)
  include Aws::Structure
end

#key_pair_nameString

The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).

If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.

Returns:

  • (String)


4009
4010
4011
4012
4013
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4009

class PasswordData < Struct.new(
  :ciphertext,
  :key_pair_name)
  include Aws::Structure
end