interface CfnKeyMixinProps

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.PaymentCryptography.Mixins.CfnKeyMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspaymentcryptography/mixins#CfnKeyMixinProps`
Java	`software.amazon.awscdk.mixins.preview.services.paymentcryptography.mixins.CfnKeyMixinProps`
Python	`aws_cdk.mixins_preview.aws_paymentcryptography.mixins.CfnKeyMixinProps`
TypeScript	`@aws-cdk/mixins-preview` » `aws_paymentcryptography` » `mixins` » `CfnKeyMixinProps`

Properties for CfnKeyPropsMixin.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as paymentcryptography_mixins } from '@aws-cdk/mixins-preview/aws-paymentcryptography';
const cfnKeyMixinProps: paymentcryptography_mixins.CfnKeyMixinProps = {
  deriveKeyUsage: 'deriveKeyUsage',
  enabled: false,
  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',
  },
  keyCheckValueAlgorithm: 'keyCheckValueAlgorithm',
  replicationRegions: ['replicationRegions'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
deriveKeyUsage?	`string`	The cryptographic usage of an ECDH derived key as deﬁned in section A.5.2 of the TR-31 spec.
enabled?	`boolean \|` `IResolvable`	Specifies whether the key is enabled.
exportable?	`boolean \|` `IResolvable`	Specifies whether the key is exportable.
keyAttributes?	`IResolvable` `\|` `KeyAttributesProperty`	The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
keyCheckValueAlgorithm?	`string`	The algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV).
replicationRegions?	`string[]`	The list of AWS Regions to remove from the key's replication configuration.
tags?	`CfnTag[]`

deriveKeyUsage?

Type: string (optional)

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

enabled?

Type: boolean | IResolvable (optional)

Specifies whether the key is enabled.

exportable?

Type: boolean | IResolvable (optional)

Specifies whether the key is exportable.

This data is immutable after the key is created.

keyAttributes?

Type: IResolvable | KeyAttributesProperty (optional)

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?

Type: string (optional)

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.

replicationRegions?

Type: string[] (optional)

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.

tags?

Type: CfnTag[] (optional)

AWS CDK

2.233.0