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

#include <GenerateDataKeyRequest.h>

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

Public Member Functions

 GenerateDataKeyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
GenerateDataKeyRequestWithKeyId (const Aws::String &value)
 
GenerateDataKeyRequestWithKeyId (Aws::String &&value)
 
GenerateDataKeyRequestWithKeyId (const char *value)
 
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)
 
GenerateDataKeyRequestWithEncryptionContext (const Aws::Map< Aws::String, Aws::String > &value)
 
GenerateDataKeyRequestWithEncryptionContext (Aws::Map< Aws::String, Aws::String > &&value)
 
GenerateDataKeyRequestAddEncryptionContext (const Aws::String &key, const Aws::String &value)
 
GenerateDataKeyRequestAddEncryptionContext (Aws::String &&key, const Aws::String &value)
 
GenerateDataKeyRequestAddEncryptionContext (const Aws::String &key, Aws::String &&value)
 
GenerateDataKeyRequestAddEncryptionContext (Aws::String &&key, Aws::String &&value)
 
GenerateDataKeyRequestAddEncryptionContext (const char *key, Aws::String &&value)
 
GenerateDataKeyRequestAddEncryptionContext (Aws::String &&key, const char *value)
 
GenerateDataKeyRequestAddEncryptionContext (const char *key, const char *value)
 
int GetNumberOfBytes () const
 
bool NumberOfBytesHasBeenSet () const
 
void SetNumberOfBytes (int value)
 
GenerateDataKeyRequestWithNumberOfBytes (int value)
 
const DataKeySpecGetKeySpec () const
 
bool KeySpecHasBeenSet () const
 
void SetKeySpec (const DataKeySpec &value)
 
void SetKeySpec (DataKeySpec &&value)
 
GenerateDataKeyRequestWithKeySpec (const DataKeySpec &value)
 
GenerateDataKeyRequestWithKeySpec (DataKeySpec &&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)
 
GenerateDataKeyRequestWithGrantTokens (const Aws::Vector< Aws::String > &value)
 
GenerateDataKeyRequestWithGrantTokens (Aws::Vector< Aws::String > &&value)
 
GenerateDataKeyRequestAddGrantTokens (const Aws::String &value)
 
GenerateDataKeyRequestAddGrantTokens (Aws::String &&value)
 
GenerateDataKeyRequestAddGrantTokens (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 GenerateDataKeyRequest.h.

Constructor & Destructor Documentation

◆ GenerateDataKeyRequest()

Aws::KMS::Model::GenerateDataKeyRequest::GenerateDataKeyRequest ( )

Member Function Documentation

◆ AddEncryptionContext() [1/7]

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

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

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 258 of file GenerateDataKeyRequest.h.

◆ AddEncryptionContext() [2/7]

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

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

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 271 of file GenerateDataKeyRequest.h.

◆ AddEncryptionContext() [3/7]

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

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

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 284 of file GenerateDataKeyRequest.h.

◆ AddEncryptionContext() [4/7]

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

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

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 297 of file GenerateDataKeyRequest.h.

◆ AddEncryptionContext() [5/7]

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

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

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 310 of file GenerateDataKeyRequest.h.

◆ AddEncryptionContext() [6/7]

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

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

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 323 of file GenerateDataKeyRequest.h.

◆ AddEncryptionContext() [7/7]

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

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

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 336 of file GenerateDataKeyRequest.h.

◆ AddGrantTokens() [1/3]

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::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 478 of file GenerateDataKeyRequest.h.

◆ AddGrantTokens() [2/3]

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::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 485 of file GenerateDataKeyRequest.h.

◆ AddGrantTokens() [3/3]

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::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 492 of file GenerateDataKeyRequest.h.

◆ EncryptionContextHasBeenSet()

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

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

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 193 of file GenerateDataKeyRequest.h.

◆ GetEncryptionContext()

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

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

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 180 of file GenerateDataKeyRequest.h.

◆ GetGrantTokens()

const Aws::Vector<Aws::String>& Aws::KMS::Model::GenerateDataKeyRequest::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 436 of file GenerateDataKeyRequest.h.

◆ GetKeyId()

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 54 of file GenerateDataKeyRequest.h.

◆ GetKeySpec()

const DataKeySpec& Aws::KMS::Model::GenerateDataKeyRequest::GetKeySpec ( ) const
inline

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 383 of file GenerateDataKeyRequest.h.

◆ GetNumberOfBytes()

int Aws::KMS::Model::GenerateDataKeyRequest::GetNumberOfBytes ( ) const
inline

Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 346 of file GenerateDataKeyRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file GenerateDataKeyRequest.h.

◆ GrantTokensHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyRequest::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 443 of file GenerateDataKeyRequest.h.

◆ KeyIdHasBeenSet()

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 70 of file GenerateDataKeyRequest.h.

◆ KeySpecHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyRequest::KeySpecHasBeenSet ( ) const
inline

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 392 of file GenerateDataKeyRequest.h.

◆ NumberOfBytesHasBeenSet()

bool Aws::KMS::Model::GenerateDataKeyRequest::NumberOfBytesHasBeenSet ( ) const
inline

Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 355 of file GenerateDataKeyRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEncryptionContext() [1/2]

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

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

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 206 of file GenerateDataKeyRequest.h.

◆ SetEncryptionContext() [2/2]

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

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

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 219 of file GenerateDataKeyRequest.h.

◆ SetGrantTokens() [1/2]

void Aws::KMS::Model::GenerateDataKeyRequest::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 450 of file GenerateDataKeyRequest.h.

◆ SetGrantTokens() [2/2]

void Aws::KMS::Model::GenerateDataKeyRequest::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 457 of file GenerateDataKeyRequest.h.

◆ SetKeyId() [1/3]

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 86 of file GenerateDataKeyRequest.h.

◆ SetKeyId() [2/3]

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 102 of file GenerateDataKeyRequest.h.

◆ SetKeyId() [3/3]

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 118 of file GenerateDataKeyRequest.h.

◆ SetKeySpec() [1/2]

void Aws::KMS::Model::GenerateDataKeyRequest::SetKeySpec ( const DataKeySpec value)
inline

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 401 of file GenerateDataKeyRequest.h.

◆ SetKeySpec() [2/2]

void Aws::KMS::Model::GenerateDataKeyRequest::SetKeySpec ( DataKeySpec &&  value)
inline

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 410 of file GenerateDataKeyRequest.h.

◆ SetNumberOfBytes()

void Aws::KMS::Model::GenerateDataKeyRequest::SetNumberOfBytes ( int  value)
inline

Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 364 of file GenerateDataKeyRequest.h.

◆ WithEncryptionContext() [1/2]

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

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

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 232 of file GenerateDataKeyRequest.h.

◆ WithEncryptionContext() [2/2]

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

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

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 245 of file GenerateDataKeyRequest.h.

◆ WithGrantTokens() [1/2]

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::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 464 of file GenerateDataKeyRequest.h.

◆ WithGrantTokens() [2/2]

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::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 471 of file GenerateDataKeyRequest.h.

◆ WithKeyId() [1/3]

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 134 of file GenerateDataKeyRequest.h.

◆ WithKeyId() [2/3]

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 150 of file GenerateDataKeyRequest.h.

◆ WithKeyId() [3/3]

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

Identifies the symmetric CMK that encrypts the data key.

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/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Definition at line 166 of file GenerateDataKeyRequest.h.

◆ WithKeySpec() [1/2]

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::WithKeySpec ( const DataKeySpec value)
inline

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 419 of file GenerateDataKeyRequest.h.

◆ WithKeySpec() [2/2]

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::WithKeySpec ( DataKeySpec &&  value)
inline

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 428 of file GenerateDataKeyRequest.h.

◆ WithNumberOfBytes()

GenerateDataKeyRequest& Aws::KMS::Model::GenerateDataKeyRequest::WithNumberOfBytes ( int  value)
inline

Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Definition at line 373 of file GenerateDataKeyRequest.h.


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