Class GenerateDataKeyResult
- All Implemented Interfaces:
Serializable
,Cloneable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Ciphertext that contains the encrypted data key.getKeyId()
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.Plaintext that contains the data key.int
hashCode()
void
setCiphertextBlob
(ByteBuffer ciphertextBlob) Ciphertext that contains the encrypted data key.void
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.void
setPlaintext
(ByteBuffer plaintext) Plaintext that contains the data key.toString()
Returns a string representation of this object; useful for testing and debugging.withCiphertextBlob
(ByteBuffer ciphertextBlob) Ciphertext that contains the encrypted data key.System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.withPlaintext
(ByteBuffer plaintext) Plaintext that contains the data key.
-
Constructor Details
-
GenerateDataKeyResult
public GenerateDataKeyResult()
-
-
Method Details
-
setCiphertextBlob
Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the Decrypt API to recover the plaintext data key and decrypt the object.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
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 that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the Decrypt API to recover the plaintext data key and decrypt the object.If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
-
getCiphertextBlob
Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the Decrypt API to recover the plaintext data key and decrypt the object.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
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:
- Ciphertext that contains the encrypted data key. You must store
the blob and enough information to reconstruct the encryption
context so that the data encrypted by using the key can later be
decrypted. You must provide both the ciphertext blob and the
encryption context to the Decrypt API to recover the
plaintext data key and decrypt the object.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
-
withCiphertextBlob
Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the Decrypt API to recover the plaintext data key and decrypt the object.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
- Parameters:
ciphertextBlob
- Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the Decrypt API to recover the plaintext data key and decrypt the object.If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPlaintext
Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.
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
- Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.
-
getPlaintext
Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.
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:
- Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.
-
withPlaintext
Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.
- Parameters:
plaintext
- Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKeyId
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
- Parameters:
keyId
- System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
-
getKeyId
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
- Returns:
- System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
-
withKeyId
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
- Parameters:
keyId
- System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.- 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
-