GenerateDataKeyWithoutPlaintextRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GenerateDataKeyWithoutPlaintextRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.

It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.

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

To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the DescribeKey operation.

If the operation succeeds, you will find the encrypted copy of the data key in the CiphertextBlob field.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted 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 CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)

Related operations:
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(java.lang.String key, java.lang.String value)` Specifies the encryption context that will be used when encrypting the data key.
`GenerateDataKeyWithoutPlaintextRequest`	`clearEncryptionContextEntries()` Removes all the entries added into EncryptionContext.
`boolean`	`equals(java.lang.Object obj)`
`java.util.Map<java.lang.String,java.lang.String>`	`getEncryptionContext()` Specifies the encryption context that will be used when encrypting the data key.
`java.util.List<java.lang.String>`	`getGrantTokens()` A list of grant tokens.
`java.lang.String`	`getKeyId()` The identifier of the symmetric customer master key (CMK) that encrypts the data key.
`java.lang.String`	`getKeySpec()` The length of the data key.
`java.lang.Integer`	`getNumberOfBytes()` The length of the data key in bytes.
`int`	`hashCode()`
`void`	`setEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)` Specifies the encryption context that will be used when encrypting the data key.
`void`	`setGrantTokens(java.util.Collection<java.lang.String> grantTokens)` A list of grant tokens.
`void`	`setKeyId(java.lang.String keyId)` The identifier of the symmetric customer master key (CMK) that encrypts the data key.
`void`	`setKeySpec(DataKeySpec keySpec)` The length of the data key.
`void`	`setKeySpec(java.lang.String keySpec)` The length of the data key.
`void`	`setNumberOfBytes(java.lang.Integer numberOfBytes)` The length of the data key in bytes.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GenerateDataKeyWithoutPlaintextRequest`	`withEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)` Specifies the encryption context that will be used when encrypting the data key.
`GenerateDataKeyWithoutPlaintextRequest`	`withGrantTokens(java.util.Collection<java.lang.String> grantTokens)` A list of grant tokens.
`GenerateDataKeyWithoutPlaintextRequest`	`withGrantTokens(java.lang.String... grantTokens)` A list of grant tokens.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeyId(java.lang.String keyId)` The identifier of the symmetric customer master key (CMK) that encrypts the data key.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeySpec(DataKeySpec keySpec)` The length of the data key.
`GenerateDataKeyWithoutPlaintextRequest`	`withKeySpec(java.lang.String keySpec)` The length of the data key.
`GenerateDataKeyWithoutPlaintextRequest`	`withNumberOfBytes(java.lang.Integer numberOfBytes)` The length of the data key in bytes.

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

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

- Constructor Detail
  - GenerateDataKeyWithoutPlaintextRequest
```
public GenerateDataKeyWithoutPlaintextRequest()
```
- Method Detail
  - getKeyId
```
public java.lang.String getKeyId()
```
    The identifier of the symmetric customer master key (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:
    The identifier of the symmetric customer master key (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(java.lang.String keyId)
```
    The identifier of the symmetric customer master key (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 -
    The identifier of the symmetric customer master key (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 GenerateDataKeyWithoutPlaintextRequest withKeyId(java.lang.String keyId)
```
    The identifier of the symmetric customer master key (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 -
    The identifier of the symmetric customer master key (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 java.util.Map<java.lang.String,java.lang.String> getEncryptionContext()
```
    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.
    
    Returns:
    
    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.
  - setEncryptionContext
```
public void setEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)
```
    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.
    
    Parameters:
    
    encryptionContext -
    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.
  - withEncryptionContext
```
public GenerateDataKeyWithoutPlaintextRequest withEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)
```
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    encryptionContext -
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addEncryptionContextEntry
```
public GenerateDataKeyWithoutPlaintextRequest addEncryptionContextEntry(java.lang.String key,
                                                                        java.lang.String value)
```
    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.
    
    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 java.lang.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(java.lang.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 GenerateDataKeyWithoutPlaintextRequest withKeySpec(java.lang.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 GenerateDataKeyWithoutPlaintextRequest 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
  - getNumberOfBytes
```
public java.lang.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(java.lang.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 GenerateDataKeyWithoutPlaintextRequest withNumberOfBytes(java.lang.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.
  - getGrantTokens
```
public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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(java.util.Collection<java.lang.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 java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.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