Class GenerateDataKeyRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddEncryptionContextEntry
(String key, String value) Removes all the entries added into EncryptionContext.clone()
Creates a shallow clone of this request.boolean
Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key.A list of grant tokens.getKeyId()
A unique identifier for the customer master key.Value that identifies the encryption algorithm and key size to generate a data key for.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.void
A unique identifier for the customer master 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.toString()
Returns a string representation of this object; useful for testing and debugging.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.withGrantTokens
(String... grantTokens) A list of grant tokens.withGrantTokens
(Collection<String> grantTokens) A list of grant tokens.A unique identifier for the customer master key.withKeySpec
(DataKeySpec keySpec) Value that identifies the encryption algorithm and key size to generate a data key for.withKeySpec
(String keySpec) Value that identifies the encryption algorithm and key size to generate a data key for.withNumberOfBytes
(Integer numberOfBytes) Integer that contains the number of bytes to generate.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
GenerateDataKeyRequest
public GenerateDataKeyRequest()
-
-
Method Details
-
setKeyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
- Parameters:
keyId
- A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
-
-
-
getKeyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
- Returns:
- A unique identifier for the customer master key. This value can
be a globally unique identifier, a fully specified ARN to either
an alias or a key, or an alias name prefixed by "alias/".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678- 1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
-
-
-
withKeyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
- Parameters:
keyId
- A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
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
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addEncryptionContextEntry
-
clearEncryptionContextEntries
Removes all the entries added into EncryptionContext. <p> Returns a reference to this object so that method calls can be chained together. -
setNumberOfBytes
Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the
KeySpec
parameter instead.- Parameters:
numberOfBytes
- Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use theKeySpec
parameter instead.
-
getNumberOfBytes
Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the
KeySpec
parameter instead.- Returns:
- Integer that contains the number of bytes to generate. Common
values are 128, 256, 512, and 1024. 1024 is the current limit. We
recommend that you use the
KeySpec
parameter instead.
-
withNumberOfBytes
Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the
KeySpec
parameter instead.- Parameters:
numberOfBytes
- Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use theKeySpec
parameter instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKeySpec
Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
- 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:
-
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.
- 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:
-
withKeySpec
Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setKeySpec
Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
- 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:
-
withKeySpec
Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setGrantTokens(java.util.Collection)
orwithGrantTokens(java.util.Collection)
if you want to override the existing values.- Parameters:
grantTokens
- A list of grant tokens.For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withGrantTokens
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-