AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::Model::KeyPairInfo Class Reference

#include <KeyPairInfo.h>

Public Member Functions

 KeyPairInfo ()
 
 KeyPairInfo (const Aws::Utils::Xml::XmlNode &xmlNode)
 
KeyPairInfooperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetKeyPairId () const
 
bool KeyPairIdHasBeenSet () const
 
void SetKeyPairId (const Aws::String &value)
 
void SetKeyPairId (Aws::String &&value)
 
void SetKeyPairId (const char *value)
 
KeyPairInfoWithKeyPairId (const Aws::String &value)
 
KeyPairInfoWithKeyPairId (Aws::String &&value)
 
KeyPairInfoWithKeyPairId (const char *value)
 
const Aws::StringGetKeyFingerprint () const
 
bool KeyFingerprintHasBeenSet () const
 
void SetKeyFingerprint (const Aws::String &value)
 
void SetKeyFingerprint (Aws::String &&value)
 
void SetKeyFingerprint (const char *value)
 
KeyPairInfoWithKeyFingerprint (const Aws::String &value)
 
KeyPairInfoWithKeyFingerprint (Aws::String &&value)
 
KeyPairInfoWithKeyFingerprint (const char *value)
 
const Aws::StringGetKeyName () const
 
bool KeyNameHasBeenSet () const
 
void SetKeyName (const Aws::String &value)
 
void SetKeyName (Aws::String &&value)
 
void SetKeyName (const char *value)
 
KeyPairInfoWithKeyName (const Aws::String &value)
 
KeyPairInfoWithKeyName (Aws::String &&value)
 
KeyPairInfoWithKeyName (const char *value)
 
const KeyTypeGetKeyType () const
 
bool KeyTypeHasBeenSet () const
 
void SetKeyType (const KeyType &value)
 
void SetKeyType (KeyType &&value)
 
KeyPairInfoWithKeyType (const KeyType &value)
 
KeyPairInfoWithKeyType (KeyType &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
KeyPairInfoWithTags (const Aws::Vector< Tag > &value)
 
KeyPairInfoWithTags (Aws::Vector< Tag > &&value)
 
KeyPairInfoAddTags (const Tag &value)
 
KeyPairInfoAddTags (Tag &&value)
 

Detailed Description

Describes a key pair.

See Also:

AWS API Reference

Definition at line 34 of file KeyPairInfo.h.

Constructor & Destructor Documentation

◆ KeyPairInfo() [1/2]

Aws::EC2::Model::KeyPairInfo::KeyPairInfo ( )

◆ KeyPairInfo() [2/2]

Aws::EC2::Model::KeyPairInfo::KeyPairInfo ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddTags() [1/2]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::AddTags ( const Tag value)
inline

Any tags applied to the key pair.

Definition at line 312 of file KeyPairInfo.h.

◆ AddTags() [2/2]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::AddTags ( Tag &&  value)
inline

Any tags applied to the key pair.

Definition at line 317 of file KeyPairInfo.h.

◆ GetKeyFingerprint()

const Aws::String& Aws::EC2::Model::KeyPairInfo::GetKeyFingerprint ( ) const
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 99 of file KeyPairInfo.h.

◆ GetKeyName()

const Aws::String& Aws::EC2::Model::KeyPairInfo::GetKeyName ( ) const
inline

The name of the key pair.

Definition at line 210 of file KeyPairInfo.h.

◆ GetKeyPairId()

const Aws::String& Aws::EC2::Model::KeyPairInfo::GetKeyPairId ( ) const
inline

The ID of the key pair.

Definition at line 48 of file KeyPairInfo.h.

◆ GetKeyType()

const KeyType& Aws::EC2::Model::KeyPairInfo::GetKeyType ( ) const
inline

The type of key pair.

Definition at line 251 of file KeyPairInfo.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::EC2::Model::KeyPairInfo::GetTags ( ) const
inline

Any tags applied to the key pair.

Definition at line 282 of file KeyPairInfo.h.

◆ KeyFingerprintHasBeenSet()

bool Aws::EC2::Model::KeyPairInfo::KeyFingerprintHasBeenSet ( ) const
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 114 of file KeyPairInfo.h.

◆ KeyNameHasBeenSet()

bool Aws::EC2::Model::KeyPairInfo::KeyNameHasBeenSet ( ) const
inline

The name of the key pair.

Definition at line 215 of file KeyPairInfo.h.

◆ KeyPairIdHasBeenSet()

bool Aws::EC2::Model::KeyPairInfo::KeyPairIdHasBeenSet ( ) const
inline

The ID of the key pair.

Definition at line 53 of file KeyPairInfo.h.

◆ KeyTypeHasBeenSet()

bool Aws::EC2::Model::KeyPairInfo::KeyTypeHasBeenSet ( ) const
inline

The type of key pair.

Definition at line 256 of file KeyPairInfo.h.

◆ operator=()

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::EC2::Model::KeyPairInfo::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::EC2::Model::KeyPairInfo::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SetKeyFingerprint() [1/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyFingerprint ( Aws::String &&  value)
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 144 of file KeyPairInfo.h.

◆ SetKeyFingerprint() [2/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyFingerprint ( const Aws::String value)
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 129 of file KeyPairInfo.h.

◆ SetKeyFingerprint() [3/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyFingerprint ( const char *  value)
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 159 of file KeyPairInfo.h.

◆ SetKeyName() [1/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyName ( Aws::String &&  value)
inline

The name of the key pair.

Definition at line 225 of file KeyPairInfo.h.

◆ SetKeyName() [2/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyName ( const Aws::String value)
inline

The name of the key pair.

Definition at line 220 of file KeyPairInfo.h.

◆ SetKeyName() [3/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyName ( const char *  value)
inline

The name of the key pair.

Definition at line 230 of file KeyPairInfo.h.

◆ SetKeyPairId() [1/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyPairId ( Aws::String &&  value)
inline

The ID of the key pair.

Definition at line 63 of file KeyPairInfo.h.

◆ SetKeyPairId() [2/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyPairId ( const Aws::String value)
inline

The ID of the key pair.

Definition at line 58 of file KeyPairInfo.h.

◆ SetKeyPairId() [3/3]

void Aws::EC2::Model::KeyPairInfo::SetKeyPairId ( const char *  value)
inline

The ID of the key pair.

Definition at line 68 of file KeyPairInfo.h.

◆ SetKeyType() [1/2]

void Aws::EC2::Model::KeyPairInfo::SetKeyType ( const KeyType value)
inline

The type of key pair.

Definition at line 261 of file KeyPairInfo.h.

◆ SetKeyType() [2/2]

void Aws::EC2::Model::KeyPairInfo::SetKeyType ( KeyType &&  value)
inline

The type of key pair.

Definition at line 266 of file KeyPairInfo.h.

◆ SetTags() [1/2]

void Aws::EC2::Model::KeyPairInfo::SetTags ( Aws::Vector< Tag > &&  value)
inline

Any tags applied to the key pair.

Definition at line 297 of file KeyPairInfo.h.

◆ SetTags() [2/2]

void Aws::EC2::Model::KeyPairInfo::SetTags ( const Aws::Vector< Tag > &  value)
inline

Any tags applied to the key pair.

Definition at line 292 of file KeyPairInfo.h.

◆ TagsHasBeenSet()

bool Aws::EC2::Model::KeyPairInfo::TagsHasBeenSet ( ) const
inline

Any tags applied to the key pair.

Definition at line 287 of file KeyPairInfo.h.

◆ WithKeyFingerprint() [1/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyFingerprint ( Aws::String &&  value)
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 189 of file KeyPairInfo.h.

◆ WithKeyFingerprint() [2/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyFingerprint ( const Aws::String value)
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 174 of file KeyPairInfo.h.

◆ WithKeyFingerprint() [3/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyFingerprint ( const char *  value)
inline

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

Definition at line 204 of file KeyPairInfo.h.

◆ WithKeyName() [1/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyName ( Aws::String &&  value)
inline

The name of the key pair.

Definition at line 240 of file KeyPairInfo.h.

◆ WithKeyName() [2/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyName ( const Aws::String value)
inline

The name of the key pair.

Definition at line 235 of file KeyPairInfo.h.

◆ WithKeyName() [3/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyName ( const char *  value)
inline

The name of the key pair.

Definition at line 245 of file KeyPairInfo.h.

◆ WithKeyPairId() [1/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyPairId ( Aws::String &&  value)
inline

The ID of the key pair.

Definition at line 78 of file KeyPairInfo.h.

◆ WithKeyPairId() [2/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyPairId ( const Aws::String value)
inline

The ID of the key pair.

Definition at line 73 of file KeyPairInfo.h.

◆ WithKeyPairId() [3/3]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyPairId ( const char *  value)
inline

The ID of the key pair.

Definition at line 83 of file KeyPairInfo.h.

◆ WithKeyType() [1/2]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyType ( const KeyType value)
inline

The type of key pair.

Definition at line 271 of file KeyPairInfo.h.

◆ WithKeyType() [2/2]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithKeyType ( KeyType &&  value)
inline

The type of key pair.

Definition at line 276 of file KeyPairInfo.h.

◆ WithTags() [1/2]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithTags ( Aws::Vector< Tag > &&  value)
inline

Any tags applied to the key pair.

Definition at line 307 of file KeyPairInfo.h.

◆ WithTags() [2/2]

KeyPairInfo& Aws::EC2::Model::KeyPairInfo::WithTags ( const Aws::Vector< Tag > &  value)
inline

Any tags applied to the key pair.

Definition at line 302 of file KeyPairInfo.h.


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