Struct aws_sdk_paymentcryptography::types::builders::WrappedKeyBuilder

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

A builder for WrappedKey.

Implementations

impl WrappedKeyBuilder

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

The KeyARN of the wrapped key.

This field is required.

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

The KeyARN of the wrapped key.

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

The KeyARN of the wrapped key.

pub fn wrapped_key_material_format( self, input: WrappedKeyMaterialFormat, ) -> Self

The key block format of a wrapped key.

This field is required.

pub fn set_wrapped_key_material_format( self, input: Option<WrappedKeyMaterialFormat>, ) -> Self

The key block format of a wrapped key.

pub fn get_wrapped_key_material_format( &self, ) -> &Option<WrappedKeyMaterialFormat>

The key block format of a wrapped key.

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

Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.

This field is required.

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

Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.

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

Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.

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

The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

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

The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

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

The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

pub fn key_check_value_algorithm(self, input: KeyCheckValueAlgorithm) -> Self

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

pub fn set_key_check_value_algorithm( self, input: Option<KeyCheckValueAlgorithm>, ) -> Self

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

pub fn get_key_check_value_algorithm(&self) -> &Option<KeyCheckValueAlgorithm>

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

pub fn build(self) -> Result<WrappedKey, BuildError>

Consumes the builder and constructs a WrappedKey. This method will fail if any of the following fields are not set:

• wrapping_key_arn
• wrapped_key_material_format
• key_material

Trait Implementations

impl Clone for WrappedKeyBuilder

fn clone(&self) -> WrappedKeyBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WrappedKeyBuilder

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

Formats the value using the given formatter.

impl Default for WrappedKeyBuilder

fn default() -> WrappedKeyBuilder

Returns the “default value” for a type.

impl PartialEq for WrappedKeyBuilder

fn eq(&self, other: &WrappedKeyBuilder) -> 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 WrappedKeyBuilder