AWS SDK for C++  1.8.93
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::PasswordData Class Reference

#include <PasswordData.h>

Public Member Functions

 PasswordData ()
 
 PasswordData (Aws::Utils::Json::JsonView jsonValue)
 
PasswordDataoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCiphertext () const
 
bool CiphertextHasBeenSet () const
 
void SetCiphertext (const Aws::String &value)
 
void SetCiphertext (Aws::String &&value)
 
void SetCiphertext (const char *value)
 
PasswordDataWithCiphertext (const Aws::String &value)
 
PasswordDataWithCiphertext (Aws::String &&value)
 
PasswordDataWithCiphertext (const char *value)
 
const Aws::StringGetKeyPairName () const
 
bool KeyPairNameHasBeenSet () const
 
void SetKeyPairName (const Aws::String &value)
 
void SetKeyPairName (Aws::String &&value)
 
void SetKeyPairName (const char *value)
 
PasswordDataWithKeyPairName (const Aws::String &value)
 
PasswordDataWithKeyPairName (Aws::String &&value)
 
PasswordDataWithKeyPairName (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 32 of file PasswordData.h.

Constructor & Destructor Documentation

◆ PasswordData() [1/2]

Aws::Lightsail::Model::PasswordData::PasswordData ( )

◆ PasswordData() [2/2]

Aws::Lightsail::Model::PasswordData::PasswordData ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CiphertextHasBeenSet()

bool Aws::Lightsail::Model::PasswordData::CiphertextHasBeenSet ( ) const
inline

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.

Definition at line 65 of file PasswordData.h.

◆ GetCiphertext()

const Aws::String& Aws::Lightsail::Model::PasswordData::GetCiphertext ( ) const
inline

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.

Definition at line 52 of file PasswordData.h.

◆ GetKeyPairName()

const Aws::String& Aws::Lightsail::Model::PasswordData::GetKeyPairName ( ) const
inline

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.

Definition at line 154 of file PasswordData.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::PasswordData::Jsonize ( ) const

◆ KeyPairNameHasBeenSet()

bool Aws::Lightsail::Model::PasswordData::KeyPairNameHasBeenSet ( ) const
inline

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.

Definition at line 164 of file PasswordData.h.

◆ operator=()

PasswordData& Aws::Lightsail::Model::PasswordData::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCiphertext() [1/3]

void Aws::Lightsail::Model::PasswordData::SetCiphertext ( const Aws::String value)
inline

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.

Definition at line 78 of file PasswordData.h.

◆ SetCiphertext() [2/3]

void Aws::Lightsail::Model::PasswordData::SetCiphertext ( Aws::String &&  value)
inline

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.

Definition at line 91 of file PasswordData.h.

◆ SetCiphertext() [3/3]

void Aws::Lightsail::Model::PasswordData::SetCiphertext ( const char *  value)
inline

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.

Definition at line 104 of file PasswordData.h.

◆ SetKeyPairName() [1/3]

void Aws::Lightsail::Model::PasswordData::SetKeyPairName ( const Aws::String value)
inline

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.

Definition at line 174 of file PasswordData.h.

◆ SetKeyPairName() [2/3]

void Aws::Lightsail::Model::PasswordData::SetKeyPairName ( Aws::String &&  value)
inline

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.

Definition at line 184 of file PasswordData.h.

◆ SetKeyPairName() [3/3]

void Aws::Lightsail::Model::PasswordData::SetKeyPairName ( const char *  value)
inline

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.

Definition at line 194 of file PasswordData.h.

◆ WithCiphertext() [1/3]

PasswordData& Aws::Lightsail::Model::PasswordData::WithCiphertext ( const Aws::String value)
inline

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.

Definition at line 117 of file PasswordData.h.

◆ WithCiphertext() [2/3]

PasswordData& Aws::Lightsail::Model::PasswordData::WithCiphertext ( Aws::String &&  value)
inline

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.

Definition at line 130 of file PasswordData.h.

◆ WithCiphertext() [3/3]

PasswordData& Aws::Lightsail::Model::PasswordData::WithCiphertext ( const char *  value)
inline

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.

Definition at line 143 of file PasswordData.h.

◆ WithKeyPairName() [1/3]

PasswordData& Aws::Lightsail::Model::PasswordData::WithKeyPairName ( const Aws::String value)
inline

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.

Definition at line 204 of file PasswordData.h.

◆ WithKeyPairName() [2/3]

PasswordData& Aws::Lightsail::Model::PasswordData::WithKeyPairName ( Aws::String &&  value)
inline

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.

Definition at line 214 of file PasswordData.h.

◆ WithKeyPairName() [3/3]

PasswordData& Aws::Lightsail::Model::PasswordData::WithKeyPairName ( const char *  value)
inline

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.

Definition at line 224 of file PasswordData.h.


The documentation for this class was generated from the following file: