GenerateDataKeyPairRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GenerateDataKeyPairRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.

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

You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.

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:GenerateDataKeyPair (key policy)

Related operations:
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GenerateDataKeyPairRequest()

Constructors
Constructor and Description
`GenerateDataKeyPairRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenerateDataKeyPairRequest`	`addEncryptionContextEntry(java.lang.String key, java.lang.String value)` Specifies the encryption context that will be used when encrypting the private key in the data key pair.
`GenerateDataKeyPairRequest`	`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 private key in the data key pair.
`java.util.List<java.lang.String>`	`getGrantTokens()` A list of grant tokens.
`java.lang.String`	`getKeyId()` Specifies the symmetric CMK that encrypts the private key in the data key pair.
`java.lang.String`	`getKeyPairSpec()` Determines the type of data key pair that is generated.
`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 private key in the data key pair.
`void`	`setGrantTokens(java.util.Collection<java.lang.String> grantTokens)` A list of grant tokens.
`void`	`setKeyId(java.lang.String keyId)` Specifies the symmetric CMK that encrypts the private key in the data key pair.
`void`	`setKeyPairSpec(DataKeyPairSpec keyPairSpec)` Determines the type of data key pair that is generated.
`void`	`setKeyPairSpec(java.lang.String keyPairSpec)` Determines the type of data key pair that is generated.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GenerateDataKeyPairRequest`	`withEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)` Specifies the encryption context that will be used when encrypting the private key in the data key pair.
`GenerateDataKeyPairRequest`	`withGrantTokens(java.util.Collection<java.lang.String> grantTokens)` A list of grant tokens.
`GenerateDataKeyPairRequest`	`withGrantTokens(java.lang.String... grantTokens)` A list of grant tokens.
`GenerateDataKeyPairRequest`	`withKeyId(java.lang.String keyId)` Specifies the symmetric CMK that encrypts the private key in the data key pair.
`GenerateDataKeyPairRequest`	`withKeyPairSpec(DataKeyPairSpec keyPairSpec)` Determines the type of data key pair that is generated.
`GenerateDataKeyPairRequest`	`withKeyPairSpec(java.lang.String keyPairSpec)` Determines the type of data key pair that is generated.

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
  - GenerateDataKeyPairRequest
```
public GenerateDataKeyPairRequest()
```
- Method Detail
  - getEncryptionContext
```
public java.util.Map<java.lang.String,java.lang.String> getEncryptionContext()
```
    Specifies the encryption context that will be used when encrypting the private key in the data key pair.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric 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 private key in the data key pair.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric 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 private key in the data key pair.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric 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 private key in the data key pair.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
  - withEncryptionContext
```
public GenerateDataKeyPairRequest withEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)
```
    Specifies the encryption context that will be used when encrypting the private key in the data key pair.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric 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 private key in the data key pair.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric 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 GenerateDataKeyPairRequest addEncryptionContextEntry(java.lang.String key,
                                                            java.lang.String value)
```
    Specifies the encryption context that will be used when encrypting the private key in the data key pair.
    
    An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric 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 GenerateDataKeyPairRequest clearEncryptionContextEntries()
```
    Removes all the entries added into EncryptionContext.
    Returns a reference to this object so that method calls can be chained together.
  - getKeyId
```
public java.lang.String getKeyId()
```
    Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
    
    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:
    Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
    
    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)
```
    Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
    
    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 -
    Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
    
    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 GenerateDataKeyPairRequest withKeyId(java.lang.String keyId)
```
    Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
    
    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 -
    Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
    
    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.
  - getKeyPairSpec
```
public java.lang.String getKeyPairSpec()
```
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Returns:
    
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    See Also:
    
    DataKeyPairSpec
  - setKeyPairSpec
```
public void setKeyPairSpec(java.lang.String keyPairSpec)
```
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Parameters:
    
    keyPairSpec -
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    See Also:
    
    DataKeyPairSpec
  - withKeyPairSpec
```
public GenerateDataKeyPairRequest withKeyPairSpec(java.lang.String keyPairSpec)
```
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Parameters:
    
    keyPairSpec -
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DataKeyPairSpec
  - setKeyPairSpec
```
public void setKeyPairSpec(DataKeyPairSpec keyPairSpec)
```
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Parameters:
    
    keyPairSpec -
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    See Also:
    
    DataKeyPairSpec
  - withKeyPairSpec
```
public GenerateDataKeyPairRequest withKeyPairSpec(DataKeyPairSpec keyPairSpec)
```
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1
    
    Parameters:
    
    keyPairSpec -
    Determines the type of data key pair that is generated.
    
    The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DataKeyPairSpec
  - 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 GenerateDataKeyPairRequest 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 GenerateDataKeyPairRequest 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 GenerateDataKeyPairRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GenerateDataKeyPairRequest

Method Detail

getEncryptionContext

setEncryptionContext

withEncryptionContext

addEncryptionContextEntry

clearEncryptionContextEntries

getKeyId

setKeyId

withKeyId

getKeyPairSpec

setKeyPairSpec

withKeyPairSpec

setKeyPairSpec

withKeyPairSpec

getGrantTokens

setGrantTokens

withGrantTokens

withGrantTokens

toString

hashCode

equals