AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::KMS::Model::GetPublicKeyResult Class Reference

#include <GetPublicKeyResult.h>

Public Member Functions

 GetPublicKeyResult ()
 
 GetPublicKeyResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetPublicKeyResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetKeyId () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
GetPublicKeyResultWithKeyId (const Aws::String &value)
 
GetPublicKeyResultWithKeyId (Aws::String &&value)
 
GetPublicKeyResultWithKeyId (const char *value)
 
const Aws::Utils::ByteBufferGetPublicKey () const
 
void SetPublicKey (const Aws::Utils::ByteBuffer &value)
 
void SetPublicKey (Aws::Utils::ByteBuffer &&value)
 
GetPublicKeyResultWithPublicKey (const Aws::Utils::ByteBuffer &value)
 
GetPublicKeyResultWithPublicKey (Aws::Utils::ByteBuffer &&value)
 
const CustomerMasterKeySpecGetCustomerMasterKeySpec () const
 
void SetCustomerMasterKeySpec (const CustomerMasterKeySpec &value)
 
void SetCustomerMasterKeySpec (CustomerMasterKeySpec &&value)
 
GetPublicKeyResultWithCustomerMasterKeySpec (const CustomerMasterKeySpec &value)
 
GetPublicKeyResultWithCustomerMasterKeySpec (CustomerMasterKeySpec &&value)
 
const KeyUsageTypeGetKeyUsage () const
 
void SetKeyUsage (const KeyUsageType &value)
 
void SetKeyUsage (KeyUsageType &&value)
 
GetPublicKeyResultWithKeyUsage (const KeyUsageType &value)
 
GetPublicKeyResultWithKeyUsage (KeyUsageType &&value)
 
const Aws::Vector< EncryptionAlgorithmSpec > & GetEncryptionAlgorithms () const
 
void SetEncryptionAlgorithms (const Aws::Vector< EncryptionAlgorithmSpec > &value)
 
void SetEncryptionAlgorithms (Aws::Vector< EncryptionAlgorithmSpec > &&value)
 
GetPublicKeyResultWithEncryptionAlgorithms (const Aws::Vector< EncryptionAlgorithmSpec > &value)
 
GetPublicKeyResultWithEncryptionAlgorithms (Aws::Vector< EncryptionAlgorithmSpec > &&value)
 
GetPublicKeyResultAddEncryptionAlgorithms (const EncryptionAlgorithmSpec &value)
 
GetPublicKeyResultAddEncryptionAlgorithms (EncryptionAlgorithmSpec &&value)
 
const Aws::Vector< SigningAlgorithmSpec > & GetSigningAlgorithms () const
 
void SetSigningAlgorithms (const Aws::Vector< SigningAlgorithmSpec > &value)
 
void SetSigningAlgorithms (Aws::Vector< SigningAlgorithmSpec > &&value)
 
GetPublicKeyResultWithSigningAlgorithms (const Aws::Vector< SigningAlgorithmSpec > &value)
 
GetPublicKeyResultWithSigningAlgorithms (Aws::Vector< SigningAlgorithmSpec > &&value)
 
GetPublicKeyResultAddSigningAlgorithms (const SigningAlgorithmSpec &value)
 
GetPublicKeyResultAddSigningAlgorithms (SigningAlgorithmSpec &&value)
 

Detailed Description

Definition at line 33 of file GetPublicKeyResult.h.

Constructor & Destructor Documentation

◆ GetPublicKeyResult() [1/2]

Aws::KMS::Model::GetPublicKeyResult::GetPublicKeyResult ( )

◆ GetPublicKeyResult() [2/2]

Aws::KMS::Model::GetPublicKeyResult::GetPublicKeyResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddEncryptionAlgorithms() [1/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::AddEncryptionAlgorithms ( const EncryptionAlgorithmSpec value)
inline

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

Definition at line 256 of file GetPublicKeyResult.h.

◆ AddEncryptionAlgorithms() [2/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::AddEncryptionAlgorithms ( EncryptionAlgorithmSpec &&  value)
inline

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

Definition at line 265 of file GetPublicKeyResult.h.

◆ AddSigningAlgorithms() [1/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::AddSigningAlgorithms ( const SigningAlgorithmSpec value)
inline

The signing algorithms that AWS KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Definition at line 308 of file GetPublicKeyResult.h.

◆ AddSigningAlgorithms() [2/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::AddSigningAlgorithms ( SigningAlgorithmSpec &&  value)
inline

The signing algorithms that AWS KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Definition at line 315 of file GetPublicKeyResult.h.

◆ GetCustomerMasterKeySpec()

const CustomerMasterKeySpec& Aws::KMS::Model::GetPublicKeyResult::GetCustomerMasterKeySpec ( ) const
inline

The type of the of the public key that was downloaded.

Definition at line 140 of file GetPublicKeyResult.h.

◆ GetEncryptionAlgorithms()

const Aws::Vector<EncryptionAlgorithmSpec>& Aws::KMS::Model::GetPublicKeyResult::GetEncryptionAlgorithms ( ) const
inline

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

Definition at line 211 of file GetPublicKeyResult.h.

◆ GetKeyId()

const Aws::String& Aws::KMS::Model::GetPublicKeyResult::GetKeyId ( ) const
inline

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Definition at line 46 of file GetPublicKeyResult.h.

◆ GetKeyUsage()

const KeyUsageType& Aws::KMS::Model::GetPublicKeyResult::GetKeyUsage ( ) const
inline

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

Definition at line 169 of file GetPublicKeyResult.h.

◆ GetPublicKey()

const Aws::Utils::ByteBuffer& Aws::KMS::Model::GetPublicKeyResult::GetPublicKey ( ) const
inline

The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 98 of file GetPublicKeyResult.h.

◆ GetSigningAlgorithms()

const Aws::Vector<SigningAlgorithmSpec>& Aws::KMS::Model::GetPublicKeyResult::GetSigningAlgorithms ( ) const
inline

The signing algorithms that AWS KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Definition at line 273 of file GetPublicKeyResult.h.

◆ operator=()

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetCustomerMasterKeySpec() [1/2]

void Aws::KMS::Model::GetPublicKeyResult::SetCustomerMasterKeySpec ( const CustomerMasterKeySpec value)
inline

The type of the of the public key that was downloaded.

Definition at line 145 of file GetPublicKeyResult.h.

◆ SetCustomerMasterKeySpec() [2/2]

void Aws::KMS::Model::GetPublicKeyResult::SetCustomerMasterKeySpec ( CustomerMasterKeySpec &&  value)
inline

The type of the of the public key that was downloaded.

Definition at line 150 of file GetPublicKeyResult.h.

◆ SetEncryptionAlgorithms() [1/2]

void Aws::KMS::Model::GetPublicKeyResult::SetEncryptionAlgorithms ( const Aws::Vector< EncryptionAlgorithmSpec > &  value)
inline

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

Definition at line 220 of file GetPublicKeyResult.h.

◆ SetEncryptionAlgorithms() [2/2]

void Aws::KMS::Model::GetPublicKeyResult::SetEncryptionAlgorithms ( Aws::Vector< EncryptionAlgorithmSpec > &&  value)
inline

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

Definition at line 229 of file GetPublicKeyResult.h.

◆ SetKeyId() [1/3]

void Aws::KMS::Model::GetPublicKeyResult::SetKeyId ( const Aws::String value)
inline

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Definition at line 53 of file GetPublicKeyResult.h.

◆ SetKeyId() [2/3]

void Aws::KMS::Model::GetPublicKeyResult::SetKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Definition at line 60 of file GetPublicKeyResult.h.

◆ SetKeyId() [3/3]

void Aws::KMS::Model::GetPublicKeyResult::SetKeyId ( const char *  value)
inline

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Definition at line 67 of file GetPublicKeyResult.h.

◆ SetKeyUsage() [1/2]

void Aws::KMS::Model::GetPublicKeyResult::SetKeyUsage ( const KeyUsageType value)
inline

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

Definition at line 177 of file GetPublicKeyResult.h.

◆ SetKeyUsage() [2/2]

void Aws::KMS::Model::GetPublicKeyResult::SetKeyUsage ( KeyUsageType &&  value)
inline

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

Definition at line 185 of file GetPublicKeyResult.h.

◆ SetPublicKey() [1/2]

void Aws::KMS::Model::GetPublicKeyResult::SetPublicKey ( const Aws::Utils::ByteBuffer value)
inline

The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 107 of file GetPublicKeyResult.h.

◆ SetPublicKey() [2/2]

void Aws::KMS::Model::GetPublicKeyResult::SetPublicKey ( Aws::Utils::ByteBuffer &&  value)
inline

The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 116 of file GetPublicKeyResult.h.

◆ SetSigningAlgorithms() [1/2]

void Aws::KMS::Model::GetPublicKeyResult::SetSigningAlgorithms ( const Aws::Vector< SigningAlgorithmSpec > &  value)
inline

The signing algorithms that AWS KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Definition at line 280 of file GetPublicKeyResult.h.

◆ SetSigningAlgorithms() [2/2]

void Aws::KMS::Model::GetPublicKeyResult::SetSigningAlgorithms ( Aws::Vector< SigningAlgorithmSpec > &&  value)
inline

The signing algorithms that AWS KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Definition at line 287 of file GetPublicKeyResult.h.

◆ WithCustomerMasterKeySpec() [1/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithCustomerMasterKeySpec ( const CustomerMasterKeySpec value)
inline

The type of the of the public key that was downloaded.

Definition at line 155 of file GetPublicKeyResult.h.

◆ WithCustomerMasterKeySpec() [2/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithCustomerMasterKeySpec ( CustomerMasterKeySpec &&  value)
inline

The type of the of the public key that was downloaded.

Definition at line 160 of file GetPublicKeyResult.h.

◆ WithEncryptionAlgorithms() [1/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithEncryptionAlgorithms ( const Aws::Vector< EncryptionAlgorithmSpec > &  value)
inline

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

Definition at line 238 of file GetPublicKeyResult.h.

◆ WithEncryptionAlgorithms() [2/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithEncryptionAlgorithms ( Aws::Vector< EncryptionAlgorithmSpec > &&  value)
inline

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

Definition at line 247 of file GetPublicKeyResult.h.

◆ WithKeyId() [1/3]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithKeyId ( const Aws::String value)
inline

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Definition at line 74 of file GetPublicKeyResult.h.

◆ WithKeyId() [2/3]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithKeyId ( Aws::String &&  value)
inline

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Definition at line 81 of file GetPublicKeyResult.h.

◆ WithKeyId() [3/3]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithKeyId ( const char *  value)
inline

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Definition at line 88 of file GetPublicKeyResult.h.

◆ WithKeyUsage() [1/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithKeyUsage ( const KeyUsageType value)
inline

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

Definition at line 193 of file GetPublicKeyResult.h.

◆ WithKeyUsage() [2/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithKeyUsage ( KeyUsageType &&  value)
inline

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

Definition at line 201 of file GetPublicKeyResult.h.

◆ WithPublicKey() [1/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithPublicKey ( const Aws::Utils::ByteBuffer value)
inline

The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 125 of file GetPublicKeyResult.h.

◆ WithPublicKey() [2/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithPublicKey ( Aws::Utils::ByteBuffer &&  value)
inline

The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 134 of file GetPublicKeyResult.h.

◆ WithSigningAlgorithms() [1/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithSigningAlgorithms ( const Aws::Vector< SigningAlgorithmSpec > &  value)
inline

The signing algorithms that AWS KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Definition at line 294 of file GetPublicKeyResult.h.

◆ WithSigningAlgorithms() [2/2]

GetPublicKeyResult& Aws::KMS::Model::GetPublicKeyResult::WithSigningAlgorithms ( Aws::Vector< SigningAlgorithmSpec > &&  value)
inline

The signing algorithms that AWS KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Definition at line 301 of file GetPublicKeyResult.h.


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