Struct aws_sdk_paymentcryptography::types::Key

#[non_exhaustive]
pub struct Key {

    pub key_arn: String,
    pub key_attributes: Option<KeyAttributes>,
    pub key_check_value: String,
    pub key_check_value_algorithm: KeyCheckValueAlgorithm,
    pub enabled: bool,
    pub exportable: bool,
    pub key_state: KeyState,
    pub key_origin: KeyOrigin,
    pub create_timestamp: DateTime,
    pub usage_start_timestamp: Option<DateTime>,
    pub usage_stop_timestamp: Option<DateTime>,
    pub delete_pending_timestamp: Option<DateTime>,
    pub delete_timestamp: Option<DateTime>,
}

Metadata about an Amazon Web Services Payment Cryptography key.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_arn: String

The Amazon Resource Name (ARN) of the key.

key_attributes: 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.

key_check_value: 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.

key_check_value_algorithm: 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.

enabled: bool

Specifies whether the key is enabled.

exportable: bool

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

key_state: KeyState

The state of key that is being created or deleted.

key_origin: 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.

create_timestamp: DateTime

The date and time when the key was created.

usage_start_timestamp: Option<DateTime>

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

usage_stop_timestamp: Option<DateTime>

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

delete_pending_timestamp: 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.

delete_timestamp: 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.

Implementations

impl Key

pub fn key_arn(&self) -> &str

The Amazon Resource Name (ARN) of the key.

pub fn 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) -> &str

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) -> &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) -> bool

Specifies whether the key is enabled.

pub fn exportable(&self) -> bool

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

pub fn key_state(&self) -> &KeyState

The state of key that is being created or deleted.

pub fn key_origin(&self) -> &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) -> &DateTime

The date and time when the key was created.

pub fn 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) -> 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) -> 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) -> 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.

impl Key

pub fn builder() -> KeyBuilder

Creates a new builder-style object to manufacture Key.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl PartialEq for Key

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