Package com.amazonaws.services.kms.model

Class EncryptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.EncryptRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class EncryptRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
EncryptRequest()

Method Summary

Modifier and Type	Method	Description
EncryptRequest	addEncryptionContextEntry(String key, String value)
EncryptRequest	clearEncryptionContextEntries()	Removes all the entries added into EncryptionContext.
EncryptRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
Map<String,String>	getEncryptionContext()	Name/value pair that specifies the encryption context to be used for authenticated encryption.
List<String>	getGrantTokens()	A list of grant tokens.
String	getKeyId()	A unique identifier for the customer master key.
ByteBuffer	getPlaintext()	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	setKeyId(String keyId)	A unique identifier for the customer master key.
void	setPlaintext(ByteBuffer plaintext)	Data to be encrypted.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
EncryptRequest	withEncryptionContext(Map<String,String> encryptionContext)	Name/value pair that specifies the encryption context to be used for authenticated encryption.
EncryptRequest	withGrantTokens(String... grantTokens)	A list of grant tokens.
EncryptRequest	withGrantTokens(Collection<String> grantTokens)	A list of grant tokens.
EncryptRequest	withKeyId(String keyId)	A unique identifier for the customer master key.
EncryptRequest	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

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptRequest

public EncryptRequest()

Method Detail

setKeyId

public 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/".

• 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

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/".

• 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

public EncryptRequest 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/".

• 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

public void setPlaintext(ByteBuffer plaintext)

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

public ByteBuffer getPlaintext()

Data to be encrypted.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position .

Returns:

Data to be encrypted.

withPlaintext

public EncryptRequest withPlaintext(ByteBuffer plaintext)

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

public Map<String,String> 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

public void setEncryptionContext(Map<String,String> 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 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 the Decrypt API or decryption will fail. For more information, see Encryption Context.

withEncryptionContext

public EncryptRequest withEncryptionContext(Map<String,String> 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 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 the Decrypt 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

public EncryptRequest addEncryptionContextEntry(String key,
                                                String value)

clearEncryptionContextEntries

public EncryptRequest clearEncryptionContextEntries()

Removes all the entries added into EncryptionContext. <p> 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, 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

public void setGrantTokens(Collection<String> grantTokens)

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

public EncryptRequest withGrantTokens(String... grantTokens)

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

public EncryptRequest withGrantTokens(Collection<String> grantTokens)

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

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EncryptRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()