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

#include <SignResult.h>

Public Member Functions

 SignResult ()
 
 SignResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
SignResultoperator= (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)
 
SignResultWithKeyId (const Aws::String &value)
 
SignResultWithKeyId (Aws::String &&value)
 
SignResultWithKeyId (const char *value)
 
const Aws::Utils::ByteBufferGetSignature () const
 
void SetSignature (const Aws::Utils::ByteBuffer &value)
 
void SetSignature (Aws::Utils::ByteBuffer &&value)
 
SignResultWithSignature (const Aws::Utils::ByteBuffer &value)
 
SignResultWithSignature (Aws::Utils::ByteBuffer &&value)
 
const SigningAlgorithmSpecGetSigningAlgorithm () const
 
void SetSigningAlgorithm (const SigningAlgorithmSpec &value)
 
void SetSigningAlgorithm (SigningAlgorithmSpec &&value)
 
SignResultWithSigningAlgorithm (const SigningAlgorithmSpec &value)
 
SignResultWithSigningAlgorithm (SigningAlgorithmSpec &&value)
 

Detailed Description

Definition at line 29 of file SignResult.h.

Constructor & Destructor Documentation

◆ SignResult() [1/2]

Aws::KMS::Model::SignResult::SignResult ( )

◆ SignResult() [2/2]

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

Member Function Documentation

◆ GetKeyId()

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

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

Definition at line 42 of file SignResult.h.

◆ GetSignature()

const Aws::Utils::ByteBuffer& Aws::KMS::Model::SignResult::GetSignature ( ) const
inline

The cryptographic signature that was generated for the message.

  • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

  • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 100 of file SignResult.h.

◆ GetSigningAlgorithm()

const SigningAlgorithmSpec& Aws::KMS::Model::SignResult::GetSigningAlgorithm ( ) const
inline

The signing algorithm that was used to sign the message.

Definition at line 166 of file SignResult.h.

◆ operator=()

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

◆ SetKeyId() [1/3]

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

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

Definition at line 49 of file SignResult.h.

◆ SetKeyId() [2/3]

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

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

Definition at line 56 of file SignResult.h.

◆ SetKeyId() [3/3]

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

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

Definition at line 63 of file SignResult.h.

◆ SetSignature() [1/2]

void Aws::KMS::Model::SignResult::SetSignature ( const Aws::Utils::ByteBuffer value)
inline

The cryptographic signature that was generated for the message.

  • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

  • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 115 of file SignResult.h.

◆ SetSignature() [2/2]

void Aws::KMS::Model::SignResult::SetSignature ( Aws::Utils::ByteBuffer &&  value)
inline

The cryptographic signature that was generated for the message.

  • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

  • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 130 of file SignResult.h.

◆ SetSigningAlgorithm() [1/2]

void Aws::KMS::Model::SignResult::SetSigningAlgorithm ( const SigningAlgorithmSpec value)
inline

The signing algorithm that was used to sign the message.

Definition at line 171 of file SignResult.h.

◆ SetSigningAlgorithm() [2/2]

void Aws::KMS::Model::SignResult::SetSigningAlgorithm ( SigningAlgorithmSpec &&  value)
inline

The signing algorithm that was used to sign the message.

Definition at line 176 of file SignResult.h.

◆ WithKeyId() [1/3]

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

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

Definition at line 70 of file SignResult.h.

◆ WithKeyId() [2/3]

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

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

Definition at line 77 of file SignResult.h.

◆ WithKeyId() [3/3]

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

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

Definition at line 84 of file SignResult.h.

◆ WithSignature() [1/2]

SignResult& Aws::KMS::Model::SignResult::WithSignature ( const Aws::Utils::ByteBuffer value)
inline

The cryptographic signature that was generated for the message.

  • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

  • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 145 of file SignResult.h.

◆ WithSignature() [2/2]

SignResult& Aws::KMS::Model::SignResult::WithSignature ( Aws::Utils::ByteBuffer &&  value)
inline

The cryptographic signature that was generated for the message.

  • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

  • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Definition at line 160 of file SignResult.h.

◆ WithSigningAlgorithm() [1/2]

SignResult& Aws::KMS::Model::SignResult::WithSigningAlgorithm ( const SigningAlgorithmSpec value)
inline

The signing algorithm that was used to sign the message.

Definition at line 181 of file SignResult.h.

◆ WithSigningAlgorithm() [2/2]

SignResult& Aws::KMS::Model::SignResult::WithSigningAlgorithm ( SigningAlgorithmSpec &&  value)
inline

The signing algorithm that was used to sign the message.

Definition at line 186 of file SignResult.h.


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