Package com.amazonaws.services.kms.model

Class ReEncryptRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.kms.model.ReEncryptRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class ReEncryptRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:

  • Constructor Details

    • ReEncryptRequest

      public ReEncryptRequest()

  • Method Details

    • setCiphertextBlob

      public void setCiphertextBlob(ByteBuffer ciphertextBlob)

      Ciphertext of the data to re-encrypt.

      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:
      ciphertextBlob - Ciphertext of the data to re-encrypt.

    • getCiphertextBlob

      public ByteBuffer getCiphertextBlob()

      Ciphertext of the data to re-encrypt.

      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 re-encrypt.

    • withCiphertextBlob

      public ReEncryptRequest withCiphertextBlob(ByteBuffer ciphertextBlob)

      Ciphertext of the data to re-encrypt.

      Parameters:
      ciphertextBlob - Ciphertext of the data to re-encrypt.
      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. <p> 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 customer master key used to re-encrypt the data. 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:
      destinationKeyId - A unique identifier for the customer master key used to re-encrypt the data. 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

    • getDestinationKeyId

      public String getDestinationKeyId()

      A unique identifier for the customer master key used to re-encrypt the data. 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 used to re-encrypt the data. 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

    • withDestinationKeyId

      public ReEncryptRequest withDestinationKeyId(String destinationKeyId)

      A unique identifier for the customer master key used to re-encrypt the data. 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:
      destinationKeyId - A unique identifier for the customer master key used to re-encrypt the data. 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.

    • getDestinationEncryptionContext

      public Map<String,String> getDestinationEncryptionContext()

      Encryption context to be used when the data is re-encrypted.

      Returns:
      Encryption context to be used when the data is re-encrypted.

    • setDestinationEncryptionContext

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

      Encryption context to be used when the data is re-encrypted.

      Parameters:
      destinationEncryptionContext - Encryption context to be used when the data is re-encrypted.

    • withDestinationEncryptionContext

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

      Encryption context to be used when the data is re-encrypted.

      Parameters:
      destinationEncryptionContext - Encryption context to be used when the data is re-encrypted.
      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. <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 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:

    • 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 request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: