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

#include <GenerateDataKeyPairRequest.h>

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

Public Member Functions

 GenerateDataKeyPairRequest ()
 
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)
 
GenerateDataKeyPairRequestWithEncryptionContext (const Aws::Map< Aws::String, Aws::String > &value)
 
GenerateDataKeyPairRequestWithEncryptionContext (Aws::Map< Aws::String, Aws::String > &&value)
 
GenerateDataKeyPairRequestAddEncryptionContext (const Aws::String &key, const Aws::String &value)
 
GenerateDataKeyPairRequestAddEncryptionContext (Aws::String &&key, const Aws::String &value)
 
GenerateDataKeyPairRequestAddEncryptionContext (const Aws::String &key, Aws::String &&value)
 
GenerateDataKeyPairRequestAddEncryptionContext (Aws::String &&key, Aws::String &&value)
 
GenerateDataKeyPairRequestAddEncryptionContext (const char *key, Aws::String &&value)
 
GenerateDataKeyPairRequestAddEncryptionContext (Aws::String &&key, const char *value)
 
GenerateDataKeyPairRequestAddEncryptionContext (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)
 
GenerateDataKeyPairRequestWithKeyId (const Aws::String &value)
 
GenerateDataKeyPairRequestWithKeyId (Aws::String &&value)
 
GenerateDataKeyPairRequestWithKeyId (const char *value)
 
const DataKeyPairSpecGetKeyPairSpec () const
 
bool KeyPairSpecHasBeenSet () const
 
void SetKeyPairSpec (const DataKeyPairSpec &value)
 
void SetKeyPairSpec (DataKeyPairSpec &&value)
 
GenerateDataKeyPairRequestWithKeyPairSpec (const DataKeyPairSpec &value)
 
GenerateDataKeyPairRequestWithKeyPairSpec (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)
 
GenerateDataKeyPairRequestWithGrantTokens (const Aws::Vector< Aws::String > &value)
 
GenerateDataKeyPairRequestWithGrantTokens (Aws::Vector< Aws::String > &&value)
 
GenerateDataKeyPairRequestAddGrantTokens (const Aws::String &value)
 
GenerateDataKeyPairRequestAddGrantTokens (Aws::String &&value)
 
GenerateDataKeyPairRequestAddGrantTokens (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 GenerateDataKeyPairRequest.h.

Constructor & Destructor Documentation

◆ GenerateDataKeyPairRequest()

Aws::KMS::Model::GenerateDataKeyPairRequest::GenerateDataKeyPairRequest ( )

Member Function Documentation

◆ AddEncryptionContext() [1/7]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 168 of file GenerateDataKeyPairRequest.h.

◆ AddEncryptionContext() [2/7]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 142 of file GenerateDataKeyPairRequest.h.

◆ AddEncryptionContext() [3/7]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 194 of file GenerateDataKeyPairRequest.h.

◆ AddEncryptionContext() [4/7]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 155 of file GenerateDataKeyPairRequest.h.

◆ AddEncryptionContext() [5/7]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 129 of file GenerateDataKeyPairRequest.h.

◆ AddEncryptionContext() [6/7]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 181 of file GenerateDataKeyPairRequest.h.

◆ AddEncryptionContext() [7/7]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 207 of file GenerateDataKeyPairRequest.h.

◆ AddGrantTokens() [1/3]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 496 of file GenerateDataKeyPairRequest.h.

◆ AddGrantTokens() [2/3]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 485 of file GenerateDataKeyPairRequest.h.

◆ AddGrantTokens() [3/3]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 507 of file GenerateDataKeyPairRequest.h.

◆ EncryptionContextHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 64 of file GenerateDataKeyPairRequest.h.

◆ GetEncryptionContext()

const Aws::Map<Aws::String, Aws::String>& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 51 of file GenerateDataKeyPairRequest.h.

◆ GetGrantTokens()

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 419 of file GenerateDataKeyPairRequest.h.

◆ GetKeyId()

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 226 of file GenerateDataKeyPairRequest.h.

◆ GetKeyPairSpec()

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

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

Definition at line 362 of file GenerateDataKeyPairRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file GenerateDataKeyPairRequest.h.

◆ GrantTokensHasBeenSet()

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 430 of file GenerateDataKeyPairRequest.h.

◆ KeyIdHasBeenSet()

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 244 of file GenerateDataKeyPairRequest.h.

◆ KeyPairSpecHasBeenSet()

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

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

Definition at line 371 of file GenerateDataKeyPairRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEncryptionContext() [1/2]

void Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 90 of file GenerateDataKeyPairRequest.h.

◆ SetEncryptionContext() [2/2]

void Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 77 of file GenerateDataKeyPairRequest.h.

◆ SetGrantTokens() [1/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 452 of file GenerateDataKeyPairRequest.h.

◆ SetGrantTokens() [2/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 441 of file GenerateDataKeyPairRequest.h.

◆ SetKeyId() [1/3]

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 280 of file GenerateDataKeyPairRequest.h.

◆ SetKeyId() [2/3]

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 262 of file GenerateDataKeyPairRequest.h.

◆ SetKeyId() [3/3]

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 298 of file GenerateDataKeyPairRequest.h.

◆ SetKeyPairSpec() [1/2]

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

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

Definition at line 380 of file GenerateDataKeyPairRequest.h.

◆ SetKeyPairSpec() [2/2]

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

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

Definition at line 389 of file GenerateDataKeyPairRequest.h.

◆ WithEncryptionContext() [1/2]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 116 of file GenerateDataKeyPairRequest.h.

◆ WithEncryptionContext() [2/2]

GenerateDataKeyPairRequest& Aws::KMS::Model::GenerateDataKeyPairRequest::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 KMS key, but it is highly recommended.

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

Definition at line 103 of file GenerateDataKeyPairRequest.h.

◆ WithGrantTokens() [1/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 474 of file GenerateDataKeyPairRequest.h.

◆ WithGrantTokens() [2/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 463 of file GenerateDataKeyPairRequest.h.

◆ WithKeyId() [1/3]

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 334 of file GenerateDataKeyPairRequest.h.

◆ WithKeyId() [2/3]

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 316 of file GenerateDataKeyPairRequest.h.

◆ WithKeyId() [3/3]

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

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 352 of file GenerateDataKeyPairRequest.h.

◆ WithKeyPairSpec() [1/2]

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

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

Definition at line 398 of file GenerateDataKeyPairRequest.h.

◆ WithKeyPairSpec() [2/2]

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

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

Definition at line 407 of file GenerateDataKeyPairRequest.h.


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