Class EncryptRequest
- 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 specifies the encryption context to be used for authenticated encryption.A list of grant tokens.getKeyId()
A unique identifier for the customer master key.Data to be encrypted.int
hashCode()
void
setEncryptionContext
(Map<String, String> encryptionContext) Name/value pair that specifies the encryption context to be used for authenticated encryption.void
setGrantTokens
(Collection<String> grantTokens) A list of grant tokens.void
A unique identifier for the customer master key.void
setPlaintext
(ByteBuffer plaintext) Data to be encrypted.toString()
Returns a string representation of this object; useful for testing and debugging.withEncryptionContext
(Map<String, String> encryptionContext) Name/value pair that specifies the encryption context to be used for authenticated encryption.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.withPlaintext
(ByteBuffer plaintext) Data to be encrypted.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
-
EncryptRequest
public EncryptRequest()
-
-
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.
-
-
setPlaintext
Data to be encrypted.
AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.
Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
- Parameters:
plaintext
- Data to be encrypted.
-
getPlaintext
Data to be encrypted.
ByteBuffer
s are stateful. Calling theirget
methods changes theirposition
. We recommend usingByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independentposition
, and callingget
methods on this rather than directly on the returnedByteBuffer
. Doing so will ensure that anyone else using theByteBuffer
will not be affected by changes to theposition
.- Returns:
- Data to be encrypted.
-
withPlaintext
Data to be encrypted.
- Parameters:
plaintext
- Data to be encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getEncryptionContext
Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the
Decrypt
API or decryption will fail. For more information, see Encryption Context.- Returns:
- Name/value pair that specifies the encryption context to be used
for authenticated encryption. If used here, the same value must
be supplied to the
Decrypt
API or decryption will fail. For more information, see Encryption Context.
-
setEncryptionContext
Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the
Decrypt
API or decryption will fail. For more information, see Encryption Context.- Parameters:
encryptionContext
- Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to theDecrypt
API or decryption will fail. For more information, see Encryption Context.
-
withEncryptionContext
Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the
Decrypt
API or decryption will fail. For more information, see Encryption Context.- Parameters:
encryptionContext
- Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to theDecrypt
API or decryption will fail. For more information, see Encryption Context.- 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. -
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:
-