com.amazonaws.services.kms.model

Class DecryptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DecryptRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DecryptRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the Decrypt operation.

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

• GenerateDataKey
• GenerateDataKeyWithoutPlaintext
• Encrypt

Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.

See Also:

AWSKMS.decrypt(DecryptRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DecryptRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DecryptRequest	addEncryptionContextEntry(String key, String value) The encryption context.
DecryptRequest	clearEncryptionContextEntries() Removes all the entries added into EncryptionContext.
DecryptRequest	clone()
boolean	equals(Object obj)
ByteBuffer	getCiphertextBlob() Ciphertext to be decrypted.
Map<String,String>	getEncryptionContext() The encryption context.
List<String>	getGrantTokens() A list of grant tokens.
int	hashCode()
void	setCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext to be decrypted.
void	setEncryptionContext(Map<String,String> encryptionContext) The encryption context.
void	setGrantTokens(Collection<String> grantTokens) A list of grant tokens.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DecryptRequest	withCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext to be decrypted.
DecryptRequest	withEncryptionContext(Map<String,String> encryptionContext) The encryption context.
DecryptRequest	withGrantTokens(Collection<String> grantTokens) A list of grant tokens.
DecryptRequest	withGrantTokens(String... grantTokens) A list of grant tokens.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DecryptRequest

public DecryptRequest()

Method Detail

getCiphertextBlob

public ByteBuffer getCiphertextBlob()

Ciphertext to be decrypted. The blob includes metadata.

Constraints:
Length: 1 - 6144

Returns:

Ciphertext to be decrypted. The blob includes metadata.

setCiphertextBlob

public void setCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext to be decrypted. The blob includes metadata.

Constraints:
Length: 1 - 6144

Parameters:

ciphertextBlob - Ciphertext to be decrypted. The blob includes metadata.

withCiphertextBlob

public DecryptRequest withCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext to be decrypted. The blob includes metadata.

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

Constraints:
Length: 1 - 6144

Parameters:

ciphertextBlob - Ciphertext to be decrypted. The blob includes metadata.

Returns:

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

getEncryptionContext

public Map<String,String> getEncryptionContext()

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Returns:

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

setEncryptionContext

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

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Parameters:

encryptionContext - The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

withEncryptionContext

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

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

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

Parameters:

encryptionContext - The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Returns:

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

addEncryptionContextEntry

public DecryptRequest addEncryptionContextEntry(String key,
                                       String value)

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

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

Removes all the entries added into EncryptionContext.

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

getGrantTokens

public List<String> getGrantTokens()

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

Constraints:
Length: 0 - 10

Returns:

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

setGrantTokens

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.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

withGrantTokens

public DecryptRequest 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.

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.

For more information, go to 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 DecryptRequest withGrantTokens(Collection<String> grantTokens)

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

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.

For more information, go to 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 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

clone

public DecryptRequest clone()

Overrides:

clone in class AmazonWebServiceRequest