The key identifier (ARN or alias) of the key for which to add replication regions.
This key must exist and be in a valid state for replication operations.
- `ReplicationRegions` Region[], required —The list of Amazon Web Services Regions to add to the key's replication configuration.
Each region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available. The key will be replicated to these regions, allowing cryptographic operations to be performed closer to your applications.
## Response `200` Success - AddKeyReplicationRegionsOutput — Output from adding replication regions to a key. - `Key` object, required —The updated key metadata after adding the replication regions.
This includes the current state of the key and its replication configuration.
- `KeyArn` string, required — The Amazon Resource Name (ARN) of the key. - `KeyAttributes` object, 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. - `KeyUsage` 'TR31_B0_BASE_DERIVATION_KEY' | 'TR31_C0_CARD_VERIFICATION_KEY' | 'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY' | 'TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION' | 'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS' | 'TR31_E1_EMV_MKEY_CONFIDENTIALITY' | 'TR31_E2_EMV_MKEY_INTEGRITY' | 'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS' | 'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION' | 'TR31_E6_EMV_MKEY_OTHER' | 'TR31_K0_KEY_ENCRYPTION_KEY' | 'TR31_K1_KEY_BLOCK_PROTECTION_KEY' | 'TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT' | 'TR31_M0_ISO_16609_MAC_KEY' | 'TR31_M3_ISO_9797_3_MAC_KEY' | 'TR31_M1_ISO_9797_1_MAC_KEY' | 'TR31_M6_ISO_9797_5_CMAC_KEY' | 'TR31_M7_HMAC_KEY' | 'TR31_P0_PIN_ENCRYPTION_KEY' | 'TR31_P1_PIN_GENERATION_KEY' | 'TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE' | 'TR31_V1_IBM3624_PIN_VERIFICATION_KEY' | 'TR31_V2_VISA_PIN_VERIFICATION_KEY' | 'TR31_K2_TR34_ASYMMETRIC_KEY', required — The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec. - `KeyClass` 'SYMMETRIC_KEY' | 'ASYMMETRIC_KEY_PAIR' | 'PRIVATE_KEY' | 'PUBLIC_KEY', required — The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair. - `KeyAlgorithm` 'TDES_2KEY' | 'TDES_3KEY' | 'AES_128' | 'AES_192' | 'AES_256' | 'HMAC_SHA256' | 'HMAC_SHA384' | 'HMAC_SHA512' | 'HMAC_SHA224' | 'RSA_2048' | 'RSA_3072' | 'RSA_4096' | 'ECC_NIST_P256' | 'ECC_NIST_P384' | 'ECC_NIST_P521', required —The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
KeyUsage.
- `KeyCheckValue` string, required — The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
- `KeyCheckValueAlgorithm` 'CMAC' | 'ANSI_X9_24' | 'HMAC' | 'SHA_1', required — The algorithm that Amazon Web Services 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. For HMAC keys, the KCV is computed using the hash selected at key creation on a zero-length message, taking the leftmost 3 bytes.
- `Enabled` boolean, required — Specifies whether the key is enabled. - `Exportable` boolean, required — Specifies whether the key is exportable. This data is immutable after the key is created. - `KeyState` 'CREATE_IN_PROGRESS' | 'CREATE_COMPLETE' | 'DELETE_PENDING' | 'DELETE_COMPLETE', required — The state of key that is being created or deleted. - `KeyOrigin` 'EXTERNAL' | 'AWS_PAYMENT_CRYPTOGRAPHY', required — The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value isAWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
- `CreateTimestamp` string, date-time, required — The date and time when the key was created.
- `UsageStartTimestamp` string, date-time — The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
- `UsageStopTimestamp` string, date-time — The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
- `DeletePendingTimestamp` string, date-time — The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
- `DeleteTimestamp` string, date-time — The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
- `DeriveKeyUsage` 'TR31_B0_BASE_DERIVATION_KEY' | 'TR31_C0_CARD_VERIFICATION_KEY' | 'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY' | 'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS' | 'TR31_E1_EMV_MKEY_CONFIDENTIALITY' | 'TR31_E2_EMV_MKEY_INTEGRITY' | 'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS' | 'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION' | 'TR31_E6_EMV_MKEY_OTHER' | 'TR31_K0_KEY_ENCRYPTION_KEY' | 'TR31_K1_KEY_BLOCK_PROTECTION_KEY' | 'TR31_M3_ISO_9797_3_MAC_KEY' | 'TR31_M1_ISO_9797_1_MAC_KEY' | 'TR31_M6_ISO_9797_5_CMAC_KEY' | 'TR31_M7_HMAC_KEY' | 'TR31_P0_PIN_ENCRYPTION_KEY' | 'TR31_P1_PIN_GENERATION_KEY' | 'TR31_V1_IBM3624_PIN_VERIFICATION_KEY' | 'TR31_V2_VISA_PIN_VERIFICATION_KEY' — The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.
- `MultiRegionKeyType` 'PRIMARY' | 'REPLICA' — Indicates whether this key is a Multi-Region key and its role in the Multi-Region key hierarchy.
Multi-Region replication keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a Primary Region key (PRK) (which can be replicated to other Amazon Web Services Regions) or a Replica Region key (RRK) (which is a copy of a PRK in another Region). For more information, see Multi-Region key replication.
- `PrimaryRegion` string —An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).
Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.
- `ReplicationStatus` object —Information about the replication status of the key across different Amazon Web Services Regions.
This field provides details about the current state of key replication, including any status messages or operational information. It helps track the progress and health of key replication operations.
- `UsingDefaultReplicationRegions` boolean —Indicates whether this key is using the account's default replication regions configuration for Multi-Region key replication.
When set to true, the key automatically replicates to the regions specified in the account's default replication settings. When set to false, the key has a custom replication configuration that overrides the account defaults.