Interface DecryptResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DecryptResponse.Builder,DecryptResponse>, KmsResponse.Builder, SdkBuilder<DecryptResponse.Builder,DecryptResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DecryptResponse

public static interface DecryptResponse.Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder<DecryptResponse.Builder,DecryptResponse>
  • Method Details

    • keyId

      The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

      Parameters:
      keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • plaintext

      DecryptResponse.Builder plaintext(SdkBytes plaintext)

      Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

      Parameters:
      plaintext - Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

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

      DecryptResponse.Builder encryptionAlgorithm(String encryptionAlgorithm)

      The encryption algorithm that was used to decrypt the ciphertext.

      Parameters:
      encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • encryptionAlgorithm

      DecryptResponse.Builder encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)

      The encryption algorithm that was used to decrypt the ciphertext.

      Parameters:
      encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • ciphertextForRecipient

      DecryptResponse.Builder ciphertextForRecipient(SdkBytes ciphertextForRecipient)

      The plaintext data encrypted with the public key in the attestation document.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

      Parameters:
      ciphertextForRecipient - The plaintext data encrypted with the public key in the attestation document.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

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