Struct aws_sdk_paymentcryptography::types::builders::KeyBuilder

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

A builder for Key.

Implementations

impl KeyBuilder

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

The Amazon Resource Name (ARN) of the key.

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

The Amazon Resource Name (ARN) of the key.

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

The Amazon Resource Name (ARN) of the key.

pub fn key_attributes(self, input: KeyAttributes) -> Self

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

pub fn set_key_attributes(self, input: Option<KeyAttributes>) -> Self

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

pub fn get_key_attributes(&self) -> &Option<KeyAttributes>

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

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

The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked 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 used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

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

The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

pub fn enabled(self, input: bool) -> Self

Specifies whether the key is enabled.

pub fn set_enabled(self, input: Option<bool>) -> Self

Specifies whether the key is enabled.

pub fn get_enabled(&self) -> &Option<bool>

Specifies whether the key is enabled.

pub fn exportable(self, input: bool) -> Self

Specifies whether the key is exportable. This data is immutable after the key is created.

pub fn set_exportable(self, input: Option<bool>) -> Self

Specifies whether the key is exportable. This data is immutable after the key is created.

pub fn get_exportable(&self) -> &Option<bool>

Specifies whether the key is exportable. This data is immutable after the key is created.

pub fn key_state(self, input: KeyState) -> Self

The state of key that is being created or deleted.

pub fn set_key_state(self, input: Option<KeyState>) -> Self

The state of key that is being created or deleted.

pub fn get_key_state(&self) -> &Option<KeyState>

The state of key that is being created or deleted.

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

The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

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

The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

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

The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

pub fn create_timestamp(self, input: DateTime) -> Self

The date and time when the key was created.

pub fn set_create_timestamp(self, input: Option<DateTime>) -> Self

The date and time when the key was created.

pub fn get_create_timestamp(&self) -> &Option<DateTime>

The date and time when the key was created.

pub fn usage_start_timestamp(self, input: DateTime) -> Self

The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.

pub fn set_usage_start_timestamp(self, input: Option<DateTime>) -> Self

The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.

pub fn get_usage_start_timestamp(&self) -> &Option<DateTime>

The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.

pub fn usage_stop_timestamp(self, input: DateTime) -> Self

The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

pub fn set_usage_stop_timestamp(self, input: Option<DateTime>) -> Self

The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

pub fn get_usage_stop_timestamp(&self) -> &Option<DateTime>

The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

pub fn delete_pending_timestamp(self, input: DateTime) -> Self

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.

pub fn set_delete_pending_timestamp(self, input: Option<DateTime>) -> Self

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.

pub fn get_delete_pending_timestamp(&self) -> &Option<DateTime>

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.

pub fn delete_timestamp(self, input: DateTime) -> Self

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.

pub fn set_delete_timestamp(self, input: Option<DateTime>) -> Self

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.

pub fn get_delete_timestamp(&self) -> &Option<DateTime>

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.

pub fn build(self) -> Key

Consumes the builder and constructs a Key.

Trait Implementations

impl Clone for KeyBuilder

fn clone(&self) -> KeyBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBuilder

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

Formats the value using the given formatter.

impl Default for KeyBuilder

fn default() -> KeyBuilder

Returns the “default value” for a type.

impl PartialEq for KeyBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for KeyBuilder