public class GenerateDataKeyRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
GenerateDataKeyRequest() |
| Modifier and Type | Method and Description |
|---|---|
GenerateDataKeyRequest |
addEncryptionContextEntry(String key,
String value) |
GenerateDataKeyRequest |
clearEncryptionContextEntries()
Removes all the entries added into EncryptionContext.
|
GenerateDataKeyRequest |
clone()
Creates a shallow clone of this request.
|
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.
|
String |
getKeyId()
A unique identifier for the customer master 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.
|
void |
setKeyId(String keyId)
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.
|
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.
|
GenerateDataKeyRequest |
withGrantTokens(String... grantTokens)
A list of grant tokens.
|
GenerateDataKeyRequest |
withKeyId(String keyId)
A unique identifier for the customer master 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.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setKeyId(String 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/".
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/".
public String 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/".
public GenerateDataKeyRequest withKeyId(String 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/".
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/".
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.
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.
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.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.
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.public GenerateDataKeyRequest addEncryptionContextEntry(String key, String value)
public GenerateDataKeyRequest clearEncryptionContextEntries()
public void setNumberOfBytes(Integer 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 the KeySpec parameter instead.
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 the KeySpec parameter instead.public Integer 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.
KeySpec parameter
instead.public GenerateDataKeyRequest withNumberOfBytes(Integer 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 the KeySpec parameter instead.
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 the KeySpec parameter instead.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.
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.DataKeySpecpublic 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.
DataKeySpecpublic 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.
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.DataKeySpecpublic 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.
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.DataKeySpecpublic 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.
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.DataKeySpecpublic List<String> getGrantTokens()
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public void setGrantTokens(Collection<String> grantTokens)
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
grantTokens - A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public GenerateDataKeyRequest withGrantTokens(String... grantTokens)
A list of grant tokens.
For more information, go to 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) or
withGrantTokens(java.util.Collection) if you want to override
the existing values.
grantTokens - A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public GenerateDataKeyRequest withGrantTokens(Collection<String> grantTokens)
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
grantTokens - A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public String toString()
toString in class ObjectObject.toString()public GenerateDataKeyRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.