{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-payment-cryptography/refs/heads/main/json-schema/openapi-create-key-input-schema.json", "title": "CreateKeyInput", "description": "CreateKeyInput schema from Amazon Payment Cryptography", "type": "object", "properties": { "Enabled": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled." } ] }, "Exportable": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Specifies whether the key is exportable from the service." } ] }, "KeyAttributes": { "allOf": [ { "$ref": "#/components/schemas/KeyAttributes" }, { "description": "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." } ] }, "KeyCheckValueAlgorithm": { "allOf": [ { "$ref": "#/components/schemas/KeyCheckValueAlgorithm" }, { "description": "
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
For DES key, the KCV is computed 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 AES key, the KCV is computed 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.
" } ] }, "Tags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "description": "The tags to attach to the key. 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.
To use this parameter, you must have TagResource permission.
Don't include 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.