com.amazonaws.services.kms.model

Class GenerateDataKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.GenerateDataKeyRequest

All Implemented Interfaces:

Serializable

public class GenerateDataKeyRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the GenerateDataKey operation.

Generates a secure data key. Data keys are used to encrypt and decrypt data. They are wrapped by customer master keys.

See Also:

AWSKMS.generateDataKey(GenerateDataKeyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GenerateDataKeyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
GenerateDataKeyRequest	addEncryptionContextEntry(String key, String value) Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key.
GenerateDataKeyRequest	clearEncryptionContextEntries() Removes all the entries added into EncryptionContext.
boolean	equals(Object obj)
Map<String,String>	getEncryptionContext() Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key.
List<String>	getGrantTokens() A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
String	getKeyId() Unique identifier of the key.
String	getKeySpec() Value that identifies the encryption algorithm and key size to generate a data key for.
Integer	getNumberOfBytes() Integer that contains the number of bytes to generate.
int	hashCode()
void	setEncryptionContext(Map<String,String> encryptionContext) Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key.
void	setGrantTokens(Collection<String> grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
void	setKeyId(String keyId) Unique identifier of the key.
void	setKeySpec(DataKeySpec keySpec) Value that identifies the encryption algorithm and key size to generate a data key for.
void	setKeySpec(String keySpec) Value that identifies the encryption algorithm and key size to generate a data key for.
void	setNumberOfBytes(Integer numberOfBytes) Integer that contains the number of bytes to generate.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GenerateDataKeyRequest	withEncryptionContext(Map<String,String> encryptionContext) Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key.
GenerateDataKeyRequest	withGrantTokens(Collection<String> grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
GenerateDataKeyRequest	withGrantTokens(String... grantTokens) A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
GenerateDataKeyRequest	withKeyId(String keyId) Unique identifier of the key.
GenerateDataKeyRequest	withKeySpec(DataKeySpec keySpec) Value that identifies the encryption algorithm and key size to generate a data key for.
GenerateDataKeyRequest	withKeySpec(String keySpec) Value that identifies the encryption algorithm and key size to generate a data key for.
GenerateDataKeyRequest	withNumberOfBytes(Integer numberOfBytes) Integer that contains the number of bytes to generate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenerateDataKeyRequest

public GenerateDataKeyRequest()

Method Detail

getKeyId

public String getKeyId()

Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.

Constraints:
Length: 1 - 256

Returns:

Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.

setKeyId

public void setKeyId(String keyId)

Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.

withKeyId

public GenerateDataKeyRequest withKeyId(String keyId)

Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

keyId - Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.

Returns:

A reference to this updated object so that method calls can be chained together.

getEncryptionContext

public Map<String,String> getEncryptionContext()

Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

Returns:

Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

setEncryptionContext

public void setEncryptionContext(Map<String,String> encryptionContext)

Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

Parameters:

encryptionContext - Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

withEncryptionContext

public GenerateDataKeyRequest withEncryptionContext(Map<String,String> encryptionContext)

Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

Returns a reference to this object so that method calls can be chained together.

Parameters:

encryptionContext - Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

Returns:

A reference to this updated object so that method calls can be chained together.

addEncryptionContextEntry

public GenerateDataKeyRequest addEncryptionContextEntry(String key,
                                               String value)

Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

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.

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()

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. 1024 is the current limit.

Constraints:
Range: 1 - 1024

Returns:

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. 1024 is the current limit.

setNumberOfBytes

public void setNumberOfBytes(Integer numberOfBytes)

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. 1024 is the current limit.

Constraints:
Range: 1 - 1024

Parameters:

numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. 1024 is the current limit.

withNumberOfBytes

public GenerateDataKeyRequest withNumberOfBytes(Integer numberOfBytes)

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. 1024 is the current limit.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1024

Parameters:

numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. 1024 is the current limit.

Returns:

A reference to this updated object so that method calls can be chained together.

getKeySpec

public String getKeySpec()

Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

Constraints:
Allowed Values: AES_256, AES_128

Returns:

Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

See Also:

DataKeySpec

setKeySpec

public void setKeySpec(String keySpec)

Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

See Also:

DataKeySpec

withKeySpec

public GenerateDataKeyRequest withKeySpec(String keySpec)

Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DataKeySpec

setKeySpec

public void setKeySpec(DataKeySpec keySpec)

Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

See Also:

DataKeySpec

withKeySpec

public GenerateDataKeyRequest withKeySpec(DataKeySpec keySpec)

Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: AES_256, AES_128

Parameters:

keySpec - Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.

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 that represent grants which can be used to provide long term permissions to generate a key.

Constraints:
Length: 0 - 10

Returns:

A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.

setGrantTokens

public void setGrantTokens(Collection<String> grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.

withGrantTokens

public GenerateDataKeyRequest withGrantTokens(String... grantTokens)

A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.

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 that represent grants which can be used to provide long term permissions to generate a key.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.

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