Struct EncapsulateOutputBuilder 

#[non_exhaustive]
pub struct EncapsulateOutputBuilder { /* private fields */ }

A builder for EncapsulateOutput.

Implementations

impl EncapsulateOutputBuilder

pub fn key_id(self, input: impl Into<String>) -> Self

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

pub fn set_key_id(self, input: Option<String>) -> Self

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

pub fn get_key_id(&self) -> &Option<String>

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

pub fn shared_secret(self, input: Blob) -> Self

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.

pub fn set_shared_secret(self, input: Option<Blob>) -> Self

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.

pub fn get_shared_secret(&self) -> &Option<Blob>

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.

pub fn shared_secret_ciphertext_blob(self, input: Blob) -> Self

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.

pub fn set_shared_secret_ciphertext_blob(self, input: Option<Blob>) -> Self

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.

pub fn get_shared_secret_ciphertext_blob(&self) -> &Option<Blob>

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.

pub fn encapsulation_algorithm(self, input: EncapsulationAlgorithmSpec) -> Self

The key encapsulation algorithm used to generate the shared secret.

pub fn set_encapsulation_algorithm( self, input: Option<EncapsulationAlgorithmSpec>, ) -> Self

The key encapsulation algorithm used to generate the shared secret.

pub fn get_encapsulation_algorithm(&self) -> &Option<EncapsulationAlgorithmSpec>

The key encapsulation algorithm used to generate the shared secret.

pub fn build(self) -> EncapsulateOutput

Consumes the builder and constructs a EncapsulateOutput.

Trait Implementations

impl Clone for EncapsulateOutputBuilder

fn clone(&self) -> EncapsulateOutputBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncapsulateOutputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EncapsulateOutputBuilder

fn default() -> EncapsulateOutputBuilder

Returns the “default value” for a type.

impl PartialEq for EncapsulateOutputBuilder

fn eq(&self, other: &EncapsulateOutputBuilder) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EncapsulateOutputBuilder