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

#include <GenerateDataKeyPairWithoutPlaintextRequest.h>

+ Inheritance diagram for Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest:

Public Member Functions

 GenerateDataKeyPairWithoutPlaintextRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Map< Aws::String, Aws::String > & GetEncryptionContext () const
 
bool EncryptionContextHasBeenSet () const
 
void SetEncryptionContext (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetEncryptionContext (Aws::Map< Aws::String, Aws::String > &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithEncryptionContext (const Aws::Map< Aws::String, Aws::String > &value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithEncryptionContext (Aws::Map< Aws::String, Aws::String > &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddEncryptionContext (const Aws::String &key, const Aws::String &value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddEncryptionContext (Aws::String &&key, const Aws::String &value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddEncryptionContext (const Aws::String &key, Aws::String &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddEncryptionContext (Aws::String &&key, Aws::String &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddEncryptionContext (const char *key, Aws::String &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddEncryptionContext (Aws::String &&key, const char *value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddEncryptionContext (const char *key, const char *value)
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithKeyId (const Aws::String &value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithKeyId (Aws::String &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithKeyId (const char *value)
 
const DataKeyPairSpecGetKeyPairSpec () const
 
bool KeyPairSpecHasBeenSet () const
 
void SetKeyPairSpec (const DataKeyPairSpec &value)
 
void SetKeyPairSpec (DataKeyPairSpec &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithKeyPairSpec (const DataKeyPairSpec &value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithKeyPairSpec (DataKeyPairSpec &&value)
 
const Aws::Vector< Aws::String > & GetGrantTokens () const
 
bool GrantTokensHasBeenSet () const
 
void SetGrantTokens (const Aws::Vector< Aws::String > &value)
 
void SetGrantTokens (Aws::Vector< Aws::String > &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithGrantTokens (const Aws::Vector< Aws::String > &value)
 
GenerateDataKeyPairWithoutPlaintextRequestWithGrantTokens (Aws::Vector< Aws::String > &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddGrantTokens (const Aws::String &value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddGrantTokens (Aws::String &&value)
 
GenerateDataKeyPairWithoutPlaintextRequestAddGrantTokens (const char *value)
 
- Public Member Functions inherited from Aws::KMS::KMSRequest
virtual ~KMSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

Constructor & Destructor Documentation

◆ GenerateDataKeyPairWithoutPlaintextRequest()

Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::GenerateDataKeyPairWithoutPlaintextRequest ( )

Member Function Documentation

◆ AddEncryptionContext() [1/7]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddEncryptionContext ( const Aws::String key,
const Aws::String value 
)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 129 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddEncryptionContext() [2/7]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddEncryptionContext ( Aws::String &&  key,
const Aws::String value 
)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 142 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddEncryptionContext() [3/7]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddEncryptionContext ( const Aws::String key,
Aws::String &&  value 
)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 155 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddEncryptionContext() [4/7]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddEncryptionContext ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 168 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddEncryptionContext() [5/7]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddEncryptionContext ( const char *  key,
Aws::String &&  value 
)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 181 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddEncryptionContext() [6/7]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddEncryptionContext ( Aws::String &&  key,
const char *  value 
)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 194 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddEncryptionContext() [7/7]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddEncryptionContext ( const char *  key,
const char *  value 
)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 207 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddGrantTokens() [1/3]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddGrantTokens ( const Aws::String value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 443 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddGrantTokens() [2/3]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddGrantTokens ( Aws::String &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 450 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ AddGrantTokens() [3/3]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::AddGrantTokens ( const char *  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 457 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ EncryptionContextHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::EncryptionContextHasBeenSet ( ) const
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 64 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ GetEncryptionContext()

const Aws::Map<Aws::String, Aws::String>& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::GetEncryptionContext ( ) const
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 51 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ GetGrantTokens()

const Aws::Vector<Aws::String>& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::GetGrantTokens ( ) const
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 401 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ GetKeyId()

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 225 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ GetKeyPairSpec()

const DataKeyPairSpec& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::GetKeyPairSpec ( ) const
inline

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Definition at line 353 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

virtual const char* Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GrantTokensHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::GrantTokensHasBeenSet ( ) const
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 408 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::KeyIdHasBeenSet ( ) const
inline

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 242 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ KeyPairSpecHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::KeyPairSpecHasBeenSet ( ) const
inline

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Definition at line 361 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SerializePayload()

Aws::String Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEncryptionContext() [1/2]

void Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::SetEncryptionContext ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 77 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetEncryptionContext() [2/2]

void Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::SetEncryptionContext ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 90 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetGrantTokens() [1/2]

void Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::SetGrantTokens ( const Aws::Vector< Aws::String > &  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 415 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetGrantTokens() [2/2]

void Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::SetGrantTokens ( Aws::Vector< Aws::String > &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 422 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetKeyId() [1/3]

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 259 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetKeyId() [2/3]

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 276 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetKeyId() [3/3]

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 293 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetKeyPairSpec() [1/2]

void Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::SetKeyPairSpec ( const DataKeyPairSpec value)
inline

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Definition at line 369 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ SetKeyPairSpec() [2/2]

void Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::SetKeyPairSpec ( DataKeyPairSpec &&  value)
inline

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Definition at line 377 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithEncryptionContext() [1/2]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::WithEncryptionContext ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 103 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithEncryptionContext() [2/2]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::WithEncryptionContext ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Definition at line 116 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithGrantTokens() [1/2]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::WithGrantTokens ( const Aws::Vector< Aws::String > &  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 429 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithGrantTokens() [2/2]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::WithGrantTokens ( Aws::Vector< Aws::String > &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 436 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithKeyId() [1/3]

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 310 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithKeyId() [2/3]

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 327 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithKeyId() [3/3]

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 344 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithKeyPairSpec() [1/2]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::WithKeyPairSpec ( const DataKeyPairSpec value)
inline

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Definition at line 385 of file GenerateDataKeyPairWithoutPlaintextRequest.h.

◆ WithKeyPairSpec() [2/2]

GenerateDataKeyPairWithoutPlaintextRequest& Aws::KMS::Model::GenerateDataKeyPairWithoutPlaintextRequest::WithKeyPairSpec ( DataKeyPairSpec &&  value)
inline

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Definition at line 393 of file GenerateDataKeyPairWithoutPlaintextRequest.h.


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