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

#include <InstanceAccessDetails.h>

Public Member Functions

 InstanceAccessDetails ()
 
 InstanceAccessDetails (Aws::Utils::Json::JsonView jsonValue)
 
InstanceAccessDetailsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCertKey () const
 
bool CertKeyHasBeenSet () const
 
void SetCertKey (const Aws::String &value)
 
void SetCertKey (Aws::String &&value)
 
void SetCertKey (const char *value)
 
InstanceAccessDetailsWithCertKey (const Aws::String &value)
 
InstanceAccessDetailsWithCertKey (Aws::String &&value)
 
InstanceAccessDetailsWithCertKey (const char *value)
 
const Aws::Utils::DateTimeGetExpiresAt () const
 
bool ExpiresAtHasBeenSet () const
 
void SetExpiresAt (const Aws::Utils::DateTime &value)
 
void SetExpiresAt (Aws::Utils::DateTime &&value)
 
InstanceAccessDetailsWithExpiresAt (const Aws::Utils::DateTime &value)
 
InstanceAccessDetailsWithExpiresAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetIpAddress () const
 
bool IpAddressHasBeenSet () const
 
void SetIpAddress (const Aws::String &value)
 
void SetIpAddress (Aws::String &&value)
 
void SetIpAddress (const char *value)
 
InstanceAccessDetailsWithIpAddress (const Aws::String &value)
 
InstanceAccessDetailsWithIpAddress (Aws::String &&value)
 
InstanceAccessDetailsWithIpAddress (const char *value)
 
const Aws::StringGetPassword () const
 
bool PasswordHasBeenSet () const
 
void SetPassword (const Aws::String &value)
 
void SetPassword (Aws::String &&value)
 
void SetPassword (const char *value)
 
InstanceAccessDetailsWithPassword (const Aws::String &value)
 
InstanceAccessDetailsWithPassword (Aws::String &&value)
 
InstanceAccessDetailsWithPassword (const char *value)
 
const PasswordDataGetPasswordData () const
 
bool PasswordDataHasBeenSet () const
 
void SetPasswordData (const PasswordData &value)
 
void SetPasswordData (PasswordData &&value)
 
InstanceAccessDetailsWithPasswordData (const PasswordData &value)
 
InstanceAccessDetailsWithPasswordData (PasswordData &&value)
 
const Aws::StringGetPrivateKey () const
 
bool PrivateKeyHasBeenSet () const
 
void SetPrivateKey (const Aws::String &value)
 
void SetPrivateKey (Aws::String &&value)
 
void SetPrivateKey (const char *value)
 
InstanceAccessDetailsWithPrivateKey (const Aws::String &value)
 
InstanceAccessDetailsWithPrivateKey (Aws::String &&value)
 
InstanceAccessDetailsWithPrivateKey (const char *value)
 
const InstanceAccessProtocolGetProtocol () const
 
bool ProtocolHasBeenSet () const
 
void SetProtocol (const InstanceAccessProtocol &value)
 
void SetProtocol (InstanceAccessProtocol &&value)
 
InstanceAccessDetailsWithProtocol (const InstanceAccessProtocol &value)
 
InstanceAccessDetailsWithProtocol (InstanceAccessProtocol &&value)
 
const Aws::StringGetInstanceName () const
 
bool InstanceNameHasBeenSet () const
 
void SetInstanceName (const Aws::String &value)
 
void SetInstanceName (Aws::String &&value)
 
void SetInstanceName (const char *value)
 
InstanceAccessDetailsWithInstanceName (const Aws::String &value)
 
InstanceAccessDetailsWithInstanceName (Aws::String &&value)
 
InstanceAccessDetailsWithInstanceName (const char *value)
 
const Aws::StringGetUsername () const
 
bool UsernameHasBeenSet () const
 
void SetUsername (const Aws::String &value)
 
void SetUsername (Aws::String &&value)
 
void SetUsername (const char *value)
 
InstanceAccessDetailsWithUsername (const Aws::String &value)
 
InstanceAccessDetailsWithUsername (Aws::String &&value)
 
InstanceAccessDetailsWithUsername (const char *value)
 
const Aws::Vector< HostKeyAttributes > & GetHostKeys () const
 
bool HostKeysHasBeenSet () const
 
void SetHostKeys (const Aws::Vector< HostKeyAttributes > &value)
 
void SetHostKeys (Aws::Vector< HostKeyAttributes > &&value)
 
InstanceAccessDetailsWithHostKeys (const Aws::Vector< HostKeyAttributes > &value)
 
InstanceAccessDetailsWithHostKeys (Aws::Vector< HostKeyAttributes > &&value)
 
InstanceAccessDetailsAddHostKeys (const HostKeyAttributes &value)
 
InstanceAccessDetailsAddHostKeys (HostKeyAttributes &&value)
 

Detailed Description

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

See Also:

AWS API Reference

Definition at line 37 of file InstanceAccessDetails.h.

Constructor & Destructor Documentation

◆ InstanceAccessDetails() [1/2]

Aws::Lightsail::Model::InstanceAccessDetails::InstanceAccessDetails ( )

◆ InstanceAccessDetails() [2/2]

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

Member Function Documentation

◆ AddHostKeys() [1/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::AddHostKeys ( const HostKeyAttributes value)
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 530 of file InstanceAccessDetails.h.

◆ AddHostKeys() [2/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::AddHostKeys ( HostKeyAttributes &&  value)
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 535 of file InstanceAccessDetails.h.

◆ CertKeyHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::CertKeyHasBeenSet ( ) const
inline

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.

Definition at line 58 of file InstanceAccessDetails.h.

◆ ExpiresAtHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::ExpiresAtHasBeenSet ( ) const
inline

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

Definition at line 111 of file InstanceAccessDetails.h.

◆ GetCertKey()

const Aws::String& Aws::Lightsail::Model::InstanceAccessDetails::GetCertKey ( ) const
inline

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.

Definition at line 51 of file InstanceAccessDetails.h.

◆ GetExpiresAt()

const Aws::Utils::DateTime& Aws::Lightsail::Model::InstanceAccessDetails::GetExpiresAt ( ) const
inline

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

Definition at line 106 of file InstanceAccessDetails.h.

◆ GetHostKeys()

const Aws::Vector<HostKeyAttributes>& Aws::Lightsail::Model::InstanceAccessDetails::GetHostKeys ( ) const
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 500 of file InstanceAccessDetails.h.

◆ GetInstanceName()

const Aws::String& Aws::Lightsail::Model::InstanceAccessDetails::GetInstanceName ( ) const
inline

The name of this Amazon Lightsail instance.

Definition at line 418 of file InstanceAccessDetails.h.

◆ GetIpAddress()

const Aws::String& Aws::Lightsail::Model::InstanceAccessDetails::GetIpAddress ( ) const
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 137 of file InstanceAccessDetails.h.

◆ GetPassword()

const Aws::String& Aws::Lightsail::Model::InstanceAccessDetails::GetPassword ( ) const
inline

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.

Definition at line 186 of file InstanceAccessDetails.h.

◆ GetPasswordData()

const PasswordData& Aws::Lightsail::Model::InstanceAccessDetails::GetPasswordData ( ) const
inline

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.

Definition at line 287 of file InstanceAccessDetails.h.

◆ GetPrivateKey()

const Aws::String& Aws::Lightsail::Model::InstanceAccessDetails::GetPrivateKey ( ) const
inline

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

Definition at line 339 of file InstanceAccessDetails.h.

◆ GetProtocol()

const InstanceAccessProtocol& Aws::Lightsail::Model::InstanceAccessDetails::GetProtocol ( ) const
inline

The protocol for these Amazon Lightsail instance access details.

Definition at line 387 of file InstanceAccessDetails.h.

◆ GetUsername()

const Aws::String& Aws::Lightsail::Model::InstanceAccessDetails::GetUsername ( ) const
inline

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

Definition at line 459 of file InstanceAccessDetails.h.

◆ HostKeysHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::HostKeysHasBeenSet ( ) const
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 505 of file InstanceAccessDetails.h.

◆ InstanceNameHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::InstanceNameHasBeenSet ( ) const
inline

The name of this Amazon Lightsail instance.

Definition at line 423 of file InstanceAccessDetails.h.

◆ IpAddressHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::IpAddressHasBeenSet ( ) const
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 142 of file InstanceAccessDetails.h.

◆ Jsonize()

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

◆ operator=()

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

◆ PasswordDataHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::PasswordDataHasBeenSet ( ) const
inline

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.

Definition at line 296 of file InstanceAccessDetails.h.

◆ PasswordHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::PasswordHasBeenSet ( ) const
inline

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.

Definition at line 199 of file InstanceAccessDetails.h.

◆ PrivateKeyHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::PrivateKeyHasBeenSet ( ) const
inline

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

Definition at line 345 of file InstanceAccessDetails.h.

◆ ProtocolHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::ProtocolHasBeenSet ( ) const
inline

The protocol for these Amazon Lightsail instance access details.

Definition at line 392 of file InstanceAccessDetails.h.

◆ SetCertKey() [1/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetCertKey ( const Aws::String value)
inline

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.

Definition at line 65 of file InstanceAccessDetails.h.

◆ SetCertKey() [2/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetCertKey ( Aws::String &&  value)
inline

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.

Definition at line 72 of file InstanceAccessDetails.h.

◆ SetCertKey() [3/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetCertKey ( const char *  value)
inline

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.

Definition at line 79 of file InstanceAccessDetails.h.

◆ SetExpiresAt() [1/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetExpiresAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 116 of file InstanceAccessDetails.h.

◆ SetExpiresAt() [2/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetExpiresAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 121 of file InstanceAccessDetails.h.

◆ SetHostKeys() [1/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetHostKeys ( const Aws::Vector< HostKeyAttributes > &  value)
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 510 of file InstanceAccessDetails.h.

◆ SetHostKeys() [2/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetHostKeys ( Aws::Vector< HostKeyAttributes > &&  value)
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 515 of file InstanceAccessDetails.h.

◆ SetInstanceName() [1/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetInstanceName ( const Aws::String value)
inline

The name of this Amazon Lightsail instance.

Definition at line 428 of file InstanceAccessDetails.h.

◆ SetInstanceName() [2/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetInstanceName ( Aws::String &&  value)
inline

The name of this Amazon Lightsail instance.

Definition at line 433 of file InstanceAccessDetails.h.

◆ SetInstanceName() [3/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetInstanceName ( const char *  value)
inline

The name of this Amazon Lightsail instance.

Definition at line 438 of file InstanceAccessDetails.h.

◆ SetIpAddress() [1/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetIpAddress ( const Aws::String value)
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 147 of file InstanceAccessDetails.h.

◆ SetIpAddress() [2/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetIpAddress ( Aws::String &&  value)
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 152 of file InstanceAccessDetails.h.

◆ SetIpAddress() [3/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetIpAddress ( const char *  value)
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 157 of file InstanceAccessDetails.h.

◆ SetPassword() [1/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPassword ( const Aws::String value)
inline

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.

Definition at line 212 of file InstanceAccessDetails.h.

◆ SetPassword() [2/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPassword ( Aws::String &&  value)
inline

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.

Definition at line 225 of file InstanceAccessDetails.h.

◆ SetPassword() [3/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPassword ( const char *  value)
inline

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.

Definition at line 238 of file InstanceAccessDetails.h.

◆ SetPasswordData() [1/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPasswordData ( const PasswordData value)
inline

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.

Definition at line 305 of file InstanceAccessDetails.h.

◆ SetPasswordData() [2/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPasswordData ( PasswordData &&  value)
inline

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.

Definition at line 314 of file InstanceAccessDetails.h.

◆ SetPrivateKey() [1/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPrivateKey ( const Aws::String value)
inline

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

Definition at line 351 of file InstanceAccessDetails.h.

◆ SetPrivateKey() [2/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPrivateKey ( Aws::String &&  value)
inline

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

Definition at line 357 of file InstanceAccessDetails.h.

◆ SetPrivateKey() [3/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetPrivateKey ( const char *  value)
inline

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

Definition at line 363 of file InstanceAccessDetails.h.

◆ SetProtocol() [1/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetProtocol ( const InstanceAccessProtocol value)
inline

The protocol for these Amazon Lightsail instance access details.

Definition at line 397 of file InstanceAccessDetails.h.

◆ SetProtocol() [2/2]

void Aws::Lightsail::Model::InstanceAccessDetails::SetProtocol ( InstanceAccessProtocol &&  value)
inline

The protocol for these Amazon Lightsail instance access details.

Definition at line 402 of file InstanceAccessDetails.h.

◆ SetUsername() [1/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetUsername ( const Aws::String value)
inline

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

Definition at line 469 of file InstanceAccessDetails.h.

◆ SetUsername() [2/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetUsername ( Aws::String &&  value)
inline

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

Definition at line 474 of file InstanceAccessDetails.h.

◆ SetUsername() [3/3]

void Aws::Lightsail::Model::InstanceAccessDetails::SetUsername ( const char *  value)
inline

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

Definition at line 479 of file InstanceAccessDetails.h.

◆ UsernameHasBeenSet()

bool Aws::Lightsail::Model::InstanceAccessDetails::UsernameHasBeenSet ( ) const
inline

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

Definition at line 464 of file InstanceAccessDetails.h.

◆ WithCertKey() [1/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithCertKey ( const Aws::String value)
inline

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.

Definition at line 86 of file InstanceAccessDetails.h.

◆ WithCertKey() [2/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithCertKey ( Aws::String &&  value)
inline

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.

Definition at line 93 of file InstanceAccessDetails.h.

◆ WithCertKey() [3/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithCertKey ( const char *  value)
inline

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.

Definition at line 100 of file InstanceAccessDetails.h.

◆ WithExpiresAt() [1/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithExpiresAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 126 of file InstanceAccessDetails.h.

◆ WithExpiresAt() [2/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithExpiresAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 131 of file InstanceAccessDetails.h.

◆ WithHostKeys() [1/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithHostKeys ( const Aws::Vector< HostKeyAttributes > &  value)
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 520 of file InstanceAccessDetails.h.

◆ WithHostKeys() [2/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithHostKeys ( Aws::Vector< HostKeyAttributes > &&  value)
inline

Describes the public SSH host keys or the RDP certificate.

Definition at line 525 of file InstanceAccessDetails.h.

◆ WithInstanceName() [1/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithInstanceName ( const Aws::String value)
inline

The name of this Amazon Lightsail instance.

Definition at line 443 of file InstanceAccessDetails.h.

◆ WithInstanceName() [2/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithInstanceName ( Aws::String &&  value)
inline

The name of this Amazon Lightsail instance.

Definition at line 448 of file InstanceAccessDetails.h.

◆ WithInstanceName() [3/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithInstanceName ( const char *  value)
inline

The name of this Amazon Lightsail instance.

Definition at line 453 of file InstanceAccessDetails.h.

◆ WithIpAddress() [1/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithIpAddress ( const Aws::String value)
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 162 of file InstanceAccessDetails.h.

◆ WithIpAddress() [2/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithIpAddress ( Aws::String &&  value)
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 167 of file InstanceAccessDetails.h.

◆ WithIpAddress() [3/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithIpAddress ( const char *  value)
inline

The public IP address of the Amazon Lightsail instance.

Definition at line 172 of file InstanceAccessDetails.h.

◆ WithPassword() [1/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPassword ( const Aws::String value)
inline

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.

Definition at line 251 of file InstanceAccessDetails.h.

◆ WithPassword() [2/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPassword ( Aws::String &&  value)
inline

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.

Definition at line 264 of file InstanceAccessDetails.h.

◆ WithPassword() [3/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPassword ( const char *  value)
inline

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.

Definition at line 277 of file InstanceAccessDetails.h.

◆ WithPasswordData() [1/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPasswordData ( const PasswordData value)
inline

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.

Definition at line 323 of file InstanceAccessDetails.h.

◆ WithPasswordData() [2/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPasswordData ( PasswordData &&  value)
inline

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.

Definition at line 332 of file InstanceAccessDetails.h.

◆ WithPrivateKey() [1/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPrivateKey ( const Aws::String value)
inline

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

Definition at line 369 of file InstanceAccessDetails.h.

◆ WithPrivateKey() [2/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPrivateKey ( Aws::String &&  value)
inline

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

Definition at line 375 of file InstanceAccessDetails.h.

◆ WithPrivateKey() [3/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithPrivateKey ( const char *  value)
inline

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

Definition at line 381 of file InstanceAccessDetails.h.

◆ WithProtocol() [1/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithProtocol ( const InstanceAccessProtocol value)
inline

The protocol for these Amazon Lightsail instance access details.

Definition at line 407 of file InstanceAccessDetails.h.

◆ WithProtocol() [2/2]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithProtocol ( InstanceAccessProtocol &&  value)
inline

The protocol for these Amazon Lightsail instance access details.

Definition at line 412 of file InstanceAccessDetails.h.

◆ WithUsername() [1/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithUsername ( const Aws::String value)
inline

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

Definition at line 484 of file InstanceAccessDetails.h.

◆ WithUsername() [2/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithUsername ( Aws::String &&  value)
inline

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

Definition at line 489 of file InstanceAccessDetails.h.

◆ WithUsername() [3/3]

InstanceAccessDetails& Aws::Lightsail::Model::InstanceAccessDetails::WithUsername ( const char *  value)
inline

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

Definition at line 494 of file InstanceAccessDetails.h.


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