GenerateDataKeyWithoutPlaintextRequest (AWS SDK for Android

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class GenerateDataKeyWithoutPlaintextRequest
extends AmazonWebServiceRequest
implements Serializable
```
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.

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.

This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation ( GenerateDataKeyWithoutPlaintext) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GenerateDataKeyWithoutPlaintextRequest()

Constructors
Constructor and Description
`GenerateDataKeyWithoutPlaintextRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenerateDataKeyWithoutPlaintextRequest`	`addEncryptionContextEntry(String key, String value)` A set of key-value pairs that represents additional authenticated data.
`GenerateDataKeyWithoutPlaintextRequest`	`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()` The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.
`String`	`getKeySpec()` The length of the data encryption key.
`Integer`	`getNumberOfBytes()` The length of the data encryption 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)` The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.
`void`	`setKeySpec(DataKeySpec keySpec)` The length of the data encryption key.
`void`	`setKeySpec(String keySpec)` The length of the data encryption key.
`void`	`setNumberOfBytes(Integer numberOfBytes)` The length of the data encryption key in bytes.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GenerateDataKeyWithoutPlaintextRequest`	`withEncryptionContext(Map<String,String> encryptionContext)` A set of key-value pairs that represents additional authenticated data.
`GenerateDataKeyWithoutPlaintextRequest`	`withGrantTokens(Collection<String> grantTokens)` A list of grant tokens.
`GenerateDataKeyWithoutPlaintextRequest`	`withGrantTokens(String... grantTokens)` A list of grant tokens.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeyId(String keyId)` The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeySpec(DataKeySpec keySpec)` The length of the data encryption key.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeySpec(String keySpec)` The length of the data encryption key.
`GenerateDataKeyWithoutPlaintextRequest`	`withNumberOfBytes(Integer numberOfBytes)` The length of the data encryption 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
  - GenerateDataKeyWithoutPlaintextRequest
```
public GenerateDataKeyWithoutPlaintextRequest()
```
- Method Detail
  - getKeyId
```
public String getKeyId()
```
    The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption 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:
    The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption 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)
```
    The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption 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 -
    The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption 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 GenerateDataKeyWithoutPlaintextRequest withKeyId(String keyId)
```
    The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption 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 -
    The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption 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 GenerateDataKeyWithoutPlaintextRequest 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 GenerateDataKeyWithoutPlaintextRequest 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 GenerateDataKeyWithoutPlaintextRequest clearEncryptionContextEntries()
```
    Removes all the entries added into EncryptionContext.
    Returns a reference to this object so that method calls can be chained together.
  - getKeySpec
```
public String getKeySpec()
```
    The length of the data encryption 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 encryption 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 encryption 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 encryption 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 GenerateDataKeyWithoutPlaintextRequest withKeySpec(String keySpec)
```
    The length of the data encryption 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 encryption 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 encryption 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 encryption 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 GenerateDataKeyWithoutPlaintextRequest withKeySpec(DataKeySpec keySpec)
```
    The length of the data encryption 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 encryption 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
  - getNumberOfBytes
```
public Integer getNumberOfBytes()
```
    The length of the data encryption 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 encryption 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 encryption 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 encryption 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 GenerateDataKeyWithoutPlaintextRequest withNumberOfBytes(Integer numberOfBytes)
```
    The length of the data encryption 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 encryption 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.
  - 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 GenerateDataKeyWithoutPlaintextRequest 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 GenerateDataKeyWithoutPlaintextRequest 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 GenerateDataKeyWithoutPlaintextRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GenerateDataKeyWithoutPlaintextRequest

Method Detail

getKeyId

setKeyId

withKeyId

getEncryptionContext

setEncryptionContext

withEncryptionContext

addEncryptionContextEntry

clearEncryptionContextEntries

getKeySpec

setKeySpec

withKeySpec

setKeySpec

withKeySpec

getNumberOfBytes

setNumberOfBytes

withNumberOfBytes

getGrantTokens

setGrantTokens

withGrantTokens

withGrantTokens

toString

hashCode

equals