libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.Types.PasswordData

Description

 
Synopsis

Documentation

data PasswordData Source #

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

See: newPasswordData smart constructor.

Constructors

PasswordData' 

Fields

  • keyPairName :: Maybe Text

    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.

  • ciphertext :: Maybe Text

    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.

Instances

Instances details
Eq PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

Read PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

Show PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

Generic PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

Associated Types

type Rep PasswordData :: Type -> Type #

NFData PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

Methods

rnf :: PasswordData -> () #

Hashable PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

FromJSON PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

type Rep PasswordData Source # 
Instance details

Defined in Amazonka.Lightsail.Types.PasswordData

type Rep PasswordData = D1 ('MetaData "PasswordData" "Amazonka.Lightsail.Types.PasswordData" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "PasswordData'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPairName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ciphertext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newPasswordData :: PasswordData Source #

Create a value of PasswordData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyPairName:PasswordData', passwordData_keyPairName - 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.

$sel:ciphertext:PasswordData', passwordData_ciphertext - 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.

passwordData_keyPairName :: Lens' PasswordData (Maybe Text) Source #

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.

passwordData_ciphertext :: Lens' PasswordData (Maybe Text) Source #

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.