Struct CreateKeyInput

#[non_exhaustive]
pub struct CreateKeyInput {
    pub key_attributes: Option<KeyAttributes>,
    pub key_check_value_algorithm: Option<KeyCheckValueAlgorithm>,
    pub exportable: Option<bool>,
    pub enabled: Option<bool>,
    pub tags: Option<Vec<Tag>>,
    pub derive_key_usage: Option<DeriveKeyUsage>,
}

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_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_algorithm: 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.

exportable: Option<bool>

Specifies whether the key is exportable from the service.

enabled: Option<bool>

Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

tags: Option<Vec<Tag>>

Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

derive_key_usage: Option<DeriveKeyUsage>

The intended cryptographic usage of keys derived from the ECC key pair to be created.

After creating an ECC key pair, you cannot change the intended cryptographic usage of keys derived from it using ECDH.

Implementations

impl CreateKeyInput

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_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 exportable(&self) -> Option<bool>

Specifies whether the key is exportable from the service.

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

Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

pub fn tags(&self) -> &[Tag]

Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn derive_key_usage(&self) -> Option<&DeriveKeyUsage>

The intended cryptographic usage of keys derived from the ECC key pair to be created.

After creating an ECC key pair, you cannot change the intended cryptographic usage of keys derived from it using ECDH.

impl CreateKeyInput

pub fn builder() -> CreateKeyInputBuilder

Creates a new builder-style object to manufacture CreateKeyInput.

Trait Implementations

impl Clone for CreateKeyInput

fn clone(&self) -> CreateKeyInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateKeyInput

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

Formats the value using the given formatter.

impl PartialEq for CreateKeyInput

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

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

const 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 CreateKeyInput