AWS::PaymentCryptography::Key - AWS CloudFormation

AWS::PaymentCryptography::Key

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). 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.

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.

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

Related operations:

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::PaymentCryptography::Key", "Properties" : { "Enabled" : Boolean, "Exportable" : Boolean, "KeyAttributes" : KeyAttributes, "KeyCheckValueAlgorithm" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::PaymentCryptography::Key Properties: Enabled: Boolean Exportable: Boolean KeyAttributes: KeyAttributes KeyCheckValueAlgorithm: String Tags: - Tag

Properties

Enabled

Specifies whether the key is enabled.

Required: No

Type: Boolean

Update requires: No interruption

Exportable

Specifies whether the key is exportable. This data is immutable after the key is created.

Required: Yes

Type: Boolean

Update requires: No interruption

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.

Required: Yes

Type: KeyAttributes

Update requires: No interruption

KeyCheckValueAlgorithm

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.

Required: No

Type: String

Allowed values: CMAC | ANSI_X9_24

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

KeyIdentifier

Property description not available.

KeyOrigin

The source of the key material. For keys created within AWS Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into AWS Payment Cryptography, the value is EXTERNAL.

KeyState

The state of key that is being created or deleted.