ImportAs2805KeyCryptogram - AWS Payment Cryptography Control Plane

ImportAs2805KeyCryptogram

Parameter information for key material import using AS2805 key cryptogram format.

Contents

As2805KeyVariant

The cryptographic usage of the key under import.

Type: String

Valid Values: TERMINAL_MAJOR_KEY_VARIANT_00 | PIN_ENCRYPTION_KEY_VARIANT_28 | MESSAGE_AUTHENTICATION_KEY_VARIANT_24 | DATA_ENCRYPTION_KEY_VARIANT_22

Required: Yes

Exportable

Specified whether the key is exportable. This data is immutable after the key is imported.

Type: Boolean

Required: Yes

KeyAlgorithm

The key algorithm of the key under import.

Type: String

Valid Values: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256 | HMAC_SHA256 | HMAC_SHA384 | HMAC_SHA512 | HMAC_SHA224 | RSA_2048 | RSA_3072 | RSA_4096 | ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521

Required: Yes

KeyModesOfUse

The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

Type: KeyModesOfUse object

Required: Yes

WrappedKeyCryptogram

The wrapped key cryptogram under import.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 4096.

Pattern: [0-9A-F]+

Required: Yes

WrappingKeyIdentifier

A key identifier that can be either a key ARN or an alias name. This allows flexible key identification in operations.

When using a key ARN, it must be a fully qualified ARN in the format: arn:aws:payment-cryptography:region:account:key/key-id.

When using an alias, it must begin with alias/ followed by the alias name.

Important

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in AWS CloudTrail logs and other output.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 322.

Pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: