GetKeyResult

data class GetKeyResult(val deriveKeyUsage: KeyDeriveKeyUsage? = null, val enabled: Boolean? = null, val exportable: Boolean? = null, val keyAttributes: KeyAttributes? = null, val keyCheckValueAlgorithm: KeyCheckValueAlgorithm? = null, val keyIdentifier: String? = null, val keyOrigin: KeyOrigin? = null, val keyState: KeyState? = null, val tags: List<Tag>? = null)

Constructors

Link copied to clipboard
constructor(deriveKeyUsage: KeyDeriveKeyUsage? = null, enabled: Boolean? = null, exportable: Boolean? = null, keyAttributes: KeyAttributes? = null, keyCheckValueAlgorithm: KeyCheckValueAlgorithm? = null, keyIdentifier: String? = null, keyOrigin: KeyOrigin? = null, keyState: KeyState? = null, tags: List<Tag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.

Link copied to clipboard
val enabled: Boolean? = null

Specifies whether the key is enabled.

Link copied to clipboard
val exportable: Boolean? = null

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

Link copied to clipboard

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.

Link copied to clipboard

The algorithm that AWS 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.

Link copied to clipboard
val keyIdentifier: String? = null
Link copied to clipboard
val keyOrigin: KeyOrigin? = null

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

Link copied to clipboard
val keyState: KeyState? = null

The state of key that is being created or deleted.

Link copied to clipboard
val tags: List<Tag>? = null