com.amazonaws.services.kms.model

Class ReEncryptRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.ReEncryptRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReEncryptRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ReEncryptRequest()

Method Summary

Modifier and Type	Method and Description
ReEncryptRequest	addDestinationEncryptionContextEntry(String key, String value)
ReEncryptRequest	addSourceEncryptionContextEntry(String key, String value)
ReEncryptRequest	clearDestinationEncryptionContextEntries() Removes all the entries added into DestinationEncryptionContext.
ReEncryptRequest	clearSourceEncryptionContextEntries() Removes all the entries added into SourceEncryptionContext.
ReEncryptRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ByteBuffer	getCiphertextBlob() Ciphertext of the data to reencrypt.
Map<String,String>	getDestinationEncryptionContext() Encryption context to use when the data is reencrypted.
String	getDestinationKeyId() A unique identifier for the CMK that is used to reencrypt the data.
List<String>	getGrantTokens() A list of grant tokens.
Map<String,String>	getSourceEncryptionContext() Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.
int	hashCode()
void	setCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext of the data to reencrypt.
void	setDestinationEncryptionContext(Map<String,String> destinationEncryptionContext) Encryption context to use when the data is reencrypted.
void	setDestinationKeyId(String destinationKeyId) A unique identifier for the CMK that is used to reencrypt the data.
void	setGrantTokens(Collection<String> grantTokens) A list of grant tokens.
void	setSourceEncryptionContext(Map<String,String> sourceEncryptionContext) Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ReEncryptRequest	withCiphertextBlob(ByteBuffer ciphertextBlob) Ciphertext of the data to reencrypt.
ReEncryptRequest	withDestinationEncryptionContext(Map<String,String> destinationEncryptionContext) Encryption context to use when the data is reencrypted.
ReEncryptRequest	withDestinationKeyId(String destinationKeyId) A unique identifier for the CMK that is used to reencrypt the data.
ReEncryptRequest	withGrantTokens(Collection<String> grantTokens) A list of grant tokens.
ReEncryptRequest	withGrantTokens(String... grantTokens) A list of grant tokens.
ReEncryptRequest	withSourceEncryptionContext(Map<String,String> sourceEncryptionContext) Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReEncryptRequest

public ReEncryptRequest()

Method Detail

setCiphertextBlob

public void setCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext of the data to reencrypt.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. 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:

ciphertextBlob - Ciphertext of the data to reencrypt.

getCiphertextBlob

public ByteBuffer getCiphertextBlob()

Ciphertext of the data to reencrypt.

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:

Ciphertext of the data to reencrypt.

withCiphertextBlob

public ReEncryptRequest withCiphertextBlob(ByteBuffer ciphertextBlob)

Ciphertext of the data to reencrypt.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. 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:

ciphertextBlob - Ciphertext of the data to reencrypt.

Returns:

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

getSourceEncryptionContext

public Map<String,String> getSourceEncryptionContext()

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Returns:

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

setSourceEncryptionContext

public void setSourceEncryptionContext(Map<String,String> sourceEncryptionContext)

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Parameters:

sourceEncryptionContext - Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

withSourceEncryptionContext

public ReEncryptRequest withSourceEncryptionContext(Map<String,String> sourceEncryptionContext)

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Parameters:

sourceEncryptionContext - Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Returns:

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

addSourceEncryptionContextEntry

public ReEncryptRequest addSourceEncryptionContextEntry(String key,
                                                        String value)

clearSourceEncryptionContextEntries

public ReEncryptRequest clearSourceEncryptionContextEntries()

Removes all the entries added into SourceEncryptionContext.

Returns:

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

setDestinationKeyId

public void setDestinationKeyId(String destinationKeyId)

A unique identifier for the CMK that is used to reencrypt the data.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Parameters:

destinationKeyId - A unique identifier for the CMK that is used to reencrypt the data.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

getDestinationKeyId

public String getDestinationKeyId()

A unique identifier for the CMK that is used to reencrypt the data.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

A unique identifier for the CMK that is used to reencrypt the data.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

withDestinationKeyId

public ReEncryptRequest withDestinationKeyId(String destinationKeyId)

A unique identifier for the CMK that is used to reencrypt the data.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Parameters:

destinationKeyId - A unique identifier for the CMK that is used to reencrypt the data.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

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

getDestinationEncryptionContext

public Map<String,String> getDestinationEncryptionContext()

Encryption context to use when the data is reencrypted.

Returns:

Encryption context to use when the data is reencrypted.

setDestinationEncryptionContext

public void setDestinationEncryptionContext(Map<String,String> destinationEncryptionContext)

Encryption context to use when the data is reencrypted.

Parameters:

destinationEncryptionContext - Encryption context to use when the data is reencrypted.

withDestinationEncryptionContext

public ReEncryptRequest withDestinationEncryptionContext(Map<String,String> destinationEncryptionContext)

Encryption context to use when the data is reencrypted.

Parameters:

destinationEncryptionContext - Encryption context to use when the data is reencrypted.

Returns:

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

addDestinationEncryptionContextEntry

public ReEncryptRequest addDestinationEncryptionContextEntry(String key,
                                                             String value)

clearDestinationEncryptionContextEntries

public ReEncryptRequest clearDestinationEncryptionContextEntries()

Removes all the entries added into DestinationEncryptionContext.

Returns:

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()