KeySummary
Metadata about an AWS Payment Cryptography key.
Contents
- Enabled
- 
               Specifies whether the key is enabled. Type: Boolean Required: Yes 
- Exportable
- 
               Specifies whether the key is exportable. This data is immutable after the key is created. Type: Boolean Required: Yes 
- KeyArn
- 
               The Amazon Resource Name (ARN) of the key. Type: String Length Constraints: Minimum length of 70. Maximum length of 150. Pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}Required: Yes 
- KeyAttributes
- 
               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. Type: KeyAttributes object Required: Yes 
- KeyCheckValue
- 
               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. Type: String Length Constraints: Minimum length of 4. Maximum length of 16. Pattern: [0-9a-fA-F]+Required: Yes 
- KeyState
- 
               The state of an AWS Payment Cryptography that is being created or deleted. Type: String Valid Values: CREATE_IN_PROGRESS | CREATE_COMPLETE | DELETE_PENDING | DELETE_COMPLETERequired: Yes 
- MultiRegionKeyType
- 
               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 AWS Regions. This field specifies whether the key is a Primary Region key (PRK) (which can be replicated to other AWS 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. Type: String Valid Values: PRIMARY | REPLICARequired: No 
- PrimaryRegion
- 
               An AWS 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 AWS Region where AWS Payment Cryptography is available. Type: String Pattern: [a-z]{2}-[a-z]{1,16}-[0-9]+Required: No 
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: