Package software.amazon.awscdk.mixins.preview.services.paymentcryptography.mixins

Class CfnKeyPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.mixins.preview.core.Mixin
software.amazon.awscdk.mixins.preview.services.paymentcryptography.mixins.CfnKeyPropsMixin
All Implemented Interfaces:
IMixin, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:28.995Z") @Stability(Stable) public class CfnKeyPropsMixin extends Mixin implements IMixin
Creates an AWS Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and AWS Region .

You use keys for cryptographic functions such as encryption and decryption.

In addition to the key material used in cryptographic operations, an AWS Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.

When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY ), key algorithm (example: TDES_2KEY ), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY ) and key modes of use (example: Encrypt ). AWS Payment Cryptography binds key attributes to keys using key blocks when you store or export them. AWS Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.

For information about valid combinations of key attributes, see Understanding key attributes in the AWS Payment Cryptography User Guide . The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.

You can use the CreateKey operation to generate an ECC (Elliptic Curve Cryptography) key pair used for establishing an ECDH (Elliptic Curve Diffie-Hellman) key agreement between two parties. In the ECDH key agreement process, both parties generate their own ECC key pair with key usage K3 and exchange the public keys. Each party then use their private key, the received public key from the other party, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm to derive a shared key.

To maintain the single-use principle of cryptographic keys in payments, ECDH derived keys should not be used for multiple purposes, such as a TR31_P0_PIN_ENCRYPTION_KEY and TR31_K1_KEY_BLOCK_PROTECTION_KEY . When creating ECC key pairs in AWS Payment Cryptography you can optionally set the DeriveKeyUsage parameter, which defines the key usage bound to the symmetric key that will be derived using the ECC key pair.

Cross-account use : This operation can't be used across different AWS accounts.

Related operations:

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.mixins.*;
 import software.amazon.awscdk.mixins.preview.services.paymentcryptography.mixins.*;
 CfnKeyPropsMixin cfnKeyPropsMixin = CfnKeyPropsMixin.Builder.create(CfnKeyMixinProps.builder()
         .deriveKeyUsage("deriveKeyUsage")
         .enabled(false)
         .exportable(false)
         .keyAttributes(KeyAttributesProperty.builder()
                 .keyAlgorithm("keyAlgorithm")
                 .keyClass("keyClass")
                 .keyModesOfUse(KeyModesOfUseProperty.builder()
                         .decrypt(false)
                         .deriveKey(false)
                         .encrypt(false)
                         .generate(false)
                         .noRestrictions(false)
                         .sign(false)
                         .unwrap(false)
                         .verify(false)
                         .wrap(false)
                         .build())
                 .keyUsage("keyUsage")
                 .build())
         .keyCheckValueAlgorithm("keyCheckValueAlgorithm")
         .replicationRegions(List.of("replicationRegions"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(PropertyMergeStrategy.OVERRIDE)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnKeyPropsMixin

      protected CfnKeyPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnKeyPropsMixin

      protected CfnKeyPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnKeyPropsMixin

      @Stability(Stable) public CfnKeyPropsMixin(@NotNull CfnKeyMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::PaymentCryptography::Key.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnKeyPropsMixin

      @Stability(Stable) public CfnKeyPropsMixin(@NotNull CfnKeyMixinProps props)
      Create a mixin to apply properties to AWS::PaymentCryptography::Key.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) @NotNull public software.constructs.IConstruct applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnKeyMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected PropertyMergeStrategy getStrategy()