CfnKeyProps Struct
Properties for defining a CfnKey.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_paymentcryptography as paymentcryptography } from 'aws-cdk-lib';
const cfnKeyProps: paymentcryptography.CfnKeyProps = {
exportable: false,
keyAttributes: {
keyAlgorithm: 'keyAlgorithm',
keyClass: 'keyClass',
keyModesOfUse: {
decrypt: false,
deriveKey: false,
encrypt: false,
generate: false,
noRestrictions: false,
sign: false,
unwrap: false,
verify: false,
wrap: false,
},
keyUsage: 'keyUsage',
},
// the properties below are optional
deriveKeyUsage: 'deriveKeyUsage',
enabled: false,
keyCheckValueAlgorithm: 'keyCheckValueAlgorithm',
policy: 'policy',
replicationRegions: ['replicationRegions'],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
deriveKeyUsageoptionalstringderive_key_usageoptionalstrderiveKeyUsageoptionalStringDeriveKeyUsageoptionalstringDeriveKeyUsageoptional*string#The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.
enabledoptionalboolean | IResolvableenabledoptionaltyping.Union[bool, IResolvable]enabledoptionalBooleanEnabledoptionalboolEnabledoptionalinterface{}#Specifies whether the key is enabled.
exportableboolean | IResolvableexportabletyping.Union[bool, IResolvable]exportableBooleanExportableboolExportableinterface{}required#Specifies whether the key is exportable.
This data is immutable after the key is created.
keyAttributesIResolvable | CfnKey.KeyAttributesPropertykey_attributestyping.Union[IResolvable, KeyAttributesProperty]keyAttributesIResolvableKeyAttributesIResolvableKeyAttributesinterface{}required#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.
keyCheckValueAlgorithmoptionalstringkey_check_value_algorithmoptionalstrkeyCheckValueAlgorithmoptionalStringKeyCheckValueAlgorithmoptionalstringKeyCheckValueAlgorithmoptional*string#The algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV).
notes
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.
The resource-based policy attached to the key, in JSON format.
replicationRegionsoptionalstring[]replication_regionsoptionaltyping.List[str]replicationRegionsoptionalList<String>ReplicationRegionsoptionalstring[]ReplicationRegionsoptional*[]*string#The list of AWS Regions to remove from the key's replication configuration.
The key will no longer be available for cryptographic operations in these regions after removal. Ensure no active operations depend on the key in these regions before removal.