GenerateDataKeyRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.GenerateDataKeyRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class GenerateDataKeyRequest
extends AmazonWebServiceRequest
implements Serializable
```
Generates a unique data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.

GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.

To generate a data key, you need to specify the customer master key (CMK) that will be used to encrypt the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field (but not both). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

You will find the plaintext copy of the data key in the Plaintext field of the response, and the encrypted copy of the data key in the CiphertextBlob field.

We recommend that you use the following pattern to encrypt data locally in your application:
1. Use the GenerateDataKey operation to get a data encryption key.
2. Use the plaintext data key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.
3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.
To decrypt data locally:
1. Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To get a cryptographically secure random byte string, use GenerateRandom.

You can use the optional encryption context to add additional security to your encryption operation. When you specify an EncryptionContext in the GenerateDataKey operation, you must specify the same encryption context (a case-sensitive exact match) in your request to Decrypt the data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide .

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GenerateDataKeyRequest()

Constructors
Constructor and Description
`GenerateDataKeyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenerateDataKeyRequest`	`addEncryptionContextEntry(String key, String value)` A set of key-value pairs that represents additional authenticated data.
`GenerateDataKeyRequest`	`clearEncryptionContextEntries()` Removes all the entries added into EncryptionContext.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getEncryptionContext()` A set of key-value pairs that represents additional authenticated data.
`List<String>`	`getGrantTokens()` A list of grant tokens.
`String`	`getKeyId()` An identifier for the CMK that encrypts the data key.
`String`	`getKeySpec()` The length of the data key.
`Integer`	`getNumberOfBytes()` The length of the data key in bytes.
`int`	`hashCode()`
`void`	`setEncryptionContext(Map<String,String> encryptionContext)` A set of key-value pairs that represents additional authenticated data.
`void`	`setGrantTokens(Collection<String> grantTokens)` A list of grant tokens.
`void`	`setKeyId(String keyId)` An identifier for the CMK that encrypts the data key.
`void`	`setKeySpec(DataKeySpec keySpec)` The length of the data key.
`void`	`setKeySpec(String keySpec)` The length of the data key.
`void`	`setNumberOfBytes(Integer numberOfBytes)` The length of the data key in bytes.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GenerateDataKeyRequest`	`withEncryptionContext(Map<String,String> encryptionContext)` A set of key-value pairs that represents additional authenticated data.
`GenerateDataKeyRequest`	`withGrantTokens(Collection<String> grantTokens)` A list of grant tokens.
`GenerateDataKeyRequest`	`withGrantTokens(String... grantTokens)` A list of grant tokens.
`GenerateDataKeyRequest`	`withKeyId(String keyId)` An identifier for the CMK that encrypts the data key.
`GenerateDataKeyRequest`	`withKeySpec(DataKeySpec keySpec)` The length of the data key.
`GenerateDataKeyRequest`	`withKeySpec(String keySpec)` The length of the data key.
`GenerateDataKeyRequest`	`withNumberOfBytes(Integer numberOfBytes)` The length of the data key in bytes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GenerateDataKeyRequest
```
public GenerateDataKeyRequest()
```
- Method Detail
  - getKeyId
```
public String getKeyId()
```
    An identifier for the 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.
    
    Constraints:
    Length: 1 - 2048
    Returns:
    An identifier for the 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.
  - setKeyId
```
public void setKeyId(String keyId)
```
    An identifier for the 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.
    
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    An identifier for the 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.
  - withKeyId
```
public GenerateDataKeyRequest withKeyId(String keyId)
```
    An identifier for the 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    An identifier for the 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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEncryptionContext
```
public Map<String,String> getEncryptionContext()
```
    A set of key-value pairs that represents additional authenticated data.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A set of key-value pairs that represents additional authenticated data.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
  - setEncryptionContext
```
public void setEncryptionContext(Map<String,String> encryptionContext)
```
    A set of key-value pairs that represents additional authenticated data.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    encryptionContext -
    A set of key-value pairs that represents additional authenticated data.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
  - withEncryptionContext
```
public GenerateDataKeyRequest withEncryptionContext(Map<String,String> encryptionContext)
```
    A set of key-value pairs that represents additional authenticated data.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    encryptionContext -
    A set of key-value pairs that represents additional authenticated data.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addEncryptionContextEntry
```
public GenerateDataKeyRequest addEncryptionContextEntry(String key,
                                                        String value)
```
    A set of key-value pairs that represents additional authenticated data.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    The method adds a new key-value pair into EncryptionContext parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into EncryptionContext.
    
    value - The corresponding value of the entry to be added into EncryptionContext.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearEncryptionContextEntries
```
public GenerateDataKeyRequest clearEncryptionContextEntries()
```
    Removes all the entries added into EncryptionContext.
    Returns a reference to this object so that method calls can be chained together.
  - getNumberOfBytes
```
public Integer getNumberOfBytes()
```
    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 common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
    
    Constraints:
    Range: 1 - 1024
    
    Returns:
    
    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 common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
  - setNumberOfBytes
```
public void setNumberOfBytes(Integer numberOfBytes)
```
    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 common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
    
    Constraints:
    Range: 1 - 1024
    
    Parameters:
    
    numberOfBytes -
    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 common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
  - withNumberOfBytes
```
public GenerateDataKeyRequest withNumberOfBytes(Integer numberOfBytes)
```
    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 common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 1024
    
    Parameters:
    
    numberOfBytes -
    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 common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKeySpec
```
public String getKeySpec()
```
    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.
    
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Returns:
    
    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.
    
    See Also:
    
    DataKeySpec
  - setKeySpec
```
public void setKeySpec(String keySpec)
```
    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.
    
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    
    keySpec -
    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.
    
    See Also:
    
    DataKeySpec
  - withKeySpec
```
public GenerateDataKeyRequest withKeySpec(String keySpec)
```
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    
    keySpec -
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DataKeySpec
  - setKeySpec
```
public void setKeySpec(DataKeySpec keySpec)
```
    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.
    
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    
    keySpec -
    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.
    
    See Also:
    
    DataKeySpec
  - withKeySpec
```
public GenerateDataKeyRequest withKeySpec(DataKeySpec keySpec)
```
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AES_256, AES_128
    
    Parameters:
    
    keySpec -
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DataKeySpec
  - getGrantTokens
```
public List<String> getGrantTokens()
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - setGrantTokens
```
public void setGrantTokens(Collection<String> grantTokens)
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - withGrantTokens
```
public GenerateDataKeyRequest withGrantTokens(String... grantTokens)
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withGrantTokens
```
public GenerateDataKeyRequest withGrantTokens(Collection<String> grantTokens)
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class GenerateDataKeyRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GenerateDataKeyRequest

Method Detail

getKeyId

setKeyId

withKeyId

getEncryptionContext

setEncryptionContext

withEncryptionContext

addEncryptionContextEntry

clearEncryptionContextEntries

getNumberOfBytes

setNumberOfBytes

withNumberOfBytes

getKeySpec

setKeySpec

withKeySpec

setKeySpec

withKeySpec

getGrantTokens

setGrantTokens

withGrantTokens

withGrantTokens

toString

hashCode

equals