Interface EncapsulateResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<EncapsulateResponse.Builder,EncapsulateResponse>, KmsResponse.Builder, SdkBuilder<EncapsulateResponse.Builder,EncapsulateResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
EncapsulateResponse
@Mutable @NotThreadSafe public static interface EncapsulateResponse.Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder<EncapsulateResponse.Builder,EncapsulateResponse>

  • Method Details

    • keyId

      EncapsulateResponse.Builder keyId(String keyId)

      The identifier of the ML-KEM KMS key used to encapsulate the shared secret.

      Parameters:
      keyId - The identifier of the ML-KEM KMS key used to encapsulate the shared secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sharedSecret

      EncapsulateResponse.Builder sharedSecret(SdkBytes sharedSecret)

      The plaintext shared secret. It is a 32-byte cryptographically random value that both parties can use directly as key material or pass through a key derivation function to generate multiple keys and nonces. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      Parameters:
      sharedSecret - The plaintext shared secret. It is a 32-byte cryptographically random value that both parties can use directly as key material or pass through a key derivation function to generate multiple keys and nonces. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sharedSecretCiphertextBlob

      EncapsulateResponse.Builder sharedSecretCiphertextBlob(SdkBytes sharedSecretCiphertextBlob)

      The encapsulated form of the shared secret. Pass this value to the Decapsulate operation to recover the shared secret. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. The length of SharedSecretCiphertextBlob depends on the ML-KEM key spec. Before Base64 encoding, the encapsulated shared secret is 768 bytes for ML_KEM_512, 1088 bytes for ML_KEM_768, and 1568 bytes for ML_KEM_1024.

      Parameters:
      sharedSecretCiphertextBlob - The encapsulated form of the shared secret. Pass this value to the Decapsulate operation to recover the shared secret. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. The length of SharedSecretCiphertextBlob depends on the ML-KEM key spec. Before Base64 encoding, the encapsulated shared secret is 768 bytes for ML_KEM_512, 1088 bytes for ML_KEM_768, and 1568 bytes for ML_KEM_1024.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encapsulationAlgorithm

      EncapsulateResponse.Builder encapsulationAlgorithm(String encapsulationAlgorithm)

      The key encapsulation algorithm used to generate the shared secret.

      Parameters:
      encapsulationAlgorithm - The key encapsulation algorithm used to generate the shared secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encapsulationAlgorithm

      EncapsulateResponse.Builder encapsulationAlgorithm(EncapsulationAlgorithmSpec encapsulationAlgorithm)

      The key encapsulation algorithm used to generate the shared secret.

      Parameters:
      encapsulationAlgorithm - The key encapsulation algorithm used to generate the shared secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: