Struct DeriveSharedSecretOutputBuilder

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

A builder for DeriveSharedSecretOutput.

Implementations

impl DeriveSharedSecretOutputBuilder

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

Identifies the KMS key used to derive the shared secret.

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

Identifies the KMS key used to derive the shared secret.

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

Identifies the KMS key used to derive the shared secret.

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

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

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

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

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

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

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

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

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

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

The plaintext shared secret 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.

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

The plaintext shared secret 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.

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

The plaintext shared secret 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.

pub fn key_agreement_algorithm(self, input: KeyAgreementAlgorithmSpec) -> Self

Identifies the key agreement algorithm used to derive the shared secret.

pub fn set_key_agreement_algorithm( self, input: Option<KeyAgreementAlgorithmSpec>, ) -> Self

Identifies the key agreement algorithm used to derive the shared secret.

pub fn get_key_agreement_algorithm(&self) -> &Option<KeyAgreementAlgorithmSpec>

Identifies the key agreement algorithm used to derive the shared secret.

pub fn key_origin(self, input: OriginType) -> Self

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

pub fn set_key_origin(self, input: Option<OriginType>) -> Self

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

pub fn get_key_origin(&self) -> &Option<OriginType>

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

pub fn build(self) -> DeriveSharedSecretOutput

Consumes the builder and constructs a DeriveSharedSecretOutput.

Trait Implementations

impl Clone for DeriveSharedSecretOutputBuilder

fn clone(&self) -> DeriveSharedSecretOutputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeriveSharedSecretOutputBuilder

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

Formats the value using the given formatter.

impl Default for DeriveSharedSecretOutputBuilder

fn default() -> DeriveSharedSecretOutputBuilder

Returns the “default value” for a type.

impl PartialEq for DeriveSharedSecretOutputBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DeriveSharedSecretOutputBuilder