This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::PaymentCryptography::Key
<a name="aws-resource-paymentcryptography-key"></a>

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](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) 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:** 
+  [DeleteKey](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html) 
+  [GetKey](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html) 
+  [ListKeys](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html) 

## Syntax
<a name="aws-resource-paymentcryptography-key-syntax"></a>

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

### JSON
<a name="aws-resource-paymentcryptography-key-syntax.json"></a>

```
{
  "Type" : "AWS::PaymentCryptography::Key",
  "Properties" : {
      "[DeriveKeyUsage](#cfn-paymentcryptography-key-derivekeyusage)" : String,
      "[Enabled](#cfn-paymentcryptography-key-enabled)" : Boolean,
      "[Exportable](#cfn-paymentcryptography-key-exportable)" : Boolean,
      "[KeyAttributes](#cfn-paymentcryptography-key-keyattributes)" : KeyAttributes,
      "[KeyCheckValueAlgorithm](#cfn-paymentcryptography-key-keycheckvaluealgorithm)" : String,
      "[ReplicationRegions](#cfn-paymentcryptography-key-replicationregions)" : [ String, ... ],
      "[Tags](#cfn-paymentcryptography-key-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-paymentcryptography-key-syntax.yaml"></a>

```
Type: AWS::PaymentCryptography::Key
Properties:
  [DeriveKeyUsage](#cfn-paymentcryptography-key-derivekeyusage): String
  [Enabled](#cfn-paymentcryptography-key-enabled): Boolean
  [Exportable](#cfn-paymentcryptography-key-exportable): Boolean
  [KeyAttributes](#cfn-paymentcryptography-key-keyattributes): 
    KeyAttributes
  [KeyCheckValueAlgorithm](#cfn-paymentcryptography-key-keycheckvaluealgorithm): String
  [ReplicationRegions](#cfn-paymentcryptography-key-replicationregions): 
    - String
  [Tags](#cfn-paymentcryptography-key-tags): 
    - Tag
```

## Properties
<a name="aws-resource-paymentcryptography-key-properties"></a>

`DeriveKeyUsage`  <a name="cfn-paymentcryptography-key-derivekeyusage"></a>
The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.  
*Required*: No  
*Type*: String  
*Allowed values*: `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`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-paymentcryptography-key-enabled"></a>
Specifies whether the key is enabled.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Exportable`  <a name="cfn-paymentcryptography-key-exportable"></a>
Specifies whether the key is exportable. This data is immutable after the key is created.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyAttributes`  <a name="cfn-paymentcryptography-key-keyattributes"></a>
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](aws-properties-paymentcryptography-key-keyattributes.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyCheckValueAlgorithm`  <a name="cfn-paymentcryptography-key-keycheckvaluealgorithm"></a>
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 | HMAC | SHA_1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReplicationRegions`  <a name="cfn-paymentcryptography-key-replicationregions"></a>
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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-paymentcryptography-key-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-paymentcryptography-key-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-paymentcryptography-key-return-values"></a>

### Ref
<a name="aws-resource-paymentcryptography-key-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-paymentcryptography-key-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-paymentcryptography-key-return-values-fn--getatt-fn--getatt"></a>

`KeyIdentifier`  <a name="KeyIdentifier-fn::getatt"></a>
Property description not available.

`KeyOrigin`  <a name="KeyOrigin-fn::getatt"></a>
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`  <a name="KeyState-fn::getatt"></a>
The state of key that is being created or deleted.

# AWS::PaymentCryptography::Key KeyAttributes
<a name="aws-properties-paymentcryptography-key-keyattributes"></a>

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.

## Syntax
<a name="aws-properties-paymentcryptography-key-keyattributes-syntax"></a>

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

### JSON
<a name="aws-properties-paymentcryptography-key-keyattributes-syntax.json"></a>

```
{
  "[KeyAlgorithm](#cfn-paymentcryptography-key-keyattributes-keyalgorithm)" : String,
  "[KeyClass](#cfn-paymentcryptography-key-keyattributes-keyclass)" : String,
  "[KeyModesOfUse](#cfn-paymentcryptography-key-keyattributes-keymodesofuse)" : KeyModesOfUse,
  "[KeyUsage](#cfn-paymentcryptography-key-keyattributes-keyusage)" : String
}
```

### YAML
<a name="aws-properties-paymentcryptography-key-keyattributes-syntax.yaml"></a>

```
  [KeyAlgorithm](#cfn-paymentcryptography-key-keyattributes-keyalgorithm): String
  [KeyClass](#cfn-paymentcryptography-key-keyattributes-keyclass): String
  [KeyModesOfUse](#cfn-paymentcryptography-key-keyattributes-keymodesofuse): 
    KeyModesOfUse
  [KeyUsage](#cfn-paymentcryptography-key-keyattributes-keyusage): String
```

## Properties
<a name="aws-properties-paymentcryptography-key-keyattributes-properties"></a>

`KeyAlgorithm`  <a name="cfn-paymentcryptography-key-keyattributes-keyalgorithm"></a>
The key algorithm to be use during creation of an AWS Payment Cryptography key.  
For symmetric keys, AWS Payment Cryptography supports `AES` and `TDES` algorithms. For asymmetric keys, AWS Payment Cryptography supports `RSA` and `ECC_NIST` algorithms.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `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`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyClass`  <a name="cfn-paymentcryptography-key-keyattributes-keyclass"></a>
The type of AWS Payment Cryptography key to create, which determines the classification of the cryptographic method and whether AWS Payment Cryptography key contains a symmetric key or an asymmetric key pair.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `SYMMETRIC_KEY | ASYMMETRIC_KEY_PAIR | PRIVATE_KEY | PUBLIC_KEY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyModesOfUse`  <a name="cfn-paymentcryptography-key-keyattributes-keymodesofuse"></a>
The list of cryptographic operations that you can perform using the key.  
*Required*: Yes  
*Type*: [KeyModesOfUse](aws-properties-paymentcryptography-key-keymodesofuse.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeyUsage`  <a name="cfn-paymentcryptography-key-keyattributes-keyusage"></a>
The cryptographic usage of an AWS Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `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`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::PaymentCryptography::Key KeyModesOfUse
<a name="aws-properties-paymentcryptography-key-keymodesofuse"></a>

The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.

## Syntax
<a name="aws-properties-paymentcryptography-key-keymodesofuse-syntax"></a>

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

### JSON
<a name="aws-properties-paymentcryptography-key-keymodesofuse-syntax.json"></a>

```
{
  "[Decrypt](#cfn-paymentcryptography-key-keymodesofuse-decrypt)" : Boolean,
  "[DeriveKey](#cfn-paymentcryptography-key-keymodesofuse-derivekey)" : Boolean,
  "[Encrypt](#cfn-paymentcryptography-key-keymodesofuse-encrypt)" : Boolean,
  "[Generate](#cfn-paymentcryptography-key-keymodesofuse-generate)" : Boolean,
  "[NoRestrictions](#cfn-paymentcryptography-key-keymodesofuse-norestrictions)" : Boolean,
  "[Sign](#cfn-paymentcryptography-key-keymodesofuse-sign)" : Boolean,
  "[Unwrap](#cfn-paymentcryptography-key-keymodesofuse-unwrap)" : Boolean,
  "[Verify](#cfn-paymentcryptography-key-keymodesofuse-verify)" : Boolean,
  "[Wrap](#cfn-paymentcryptography-key-keymodesofuse-wrap)" : Boolean
}
```

### YAML
<a name="aws-properties-paymentcryptography-key-keymodesofuse-syntax.yaml"></a>

```
  [Decrypt](#cfn-paymentcryptography-key-keymodesofuse-decrypt): Boolean
  [DeriveKey](#cfn-paymentcryptography-key-keymodesofuse-derivekey): Boolean
  [Encrypt](#cfn-paymentcryptography-key-keymodesofuse-encrypt): Boolean
  [Generate](#cfn-paymentcryptography-key-keymodesofuse-generate): Boolean
  [NoRestrictions](#cfn-paymentcryptography-key-keymodesofuse-norestrictions): Boolean
  [Sign](#cfn-paymentcryptography-key-keymodesofuse-sign): Boolean
  [Unwrap](#cfn-paymentcryptography-key-keymodesofuse-unwrap): Boolean
  [Verify](#cfn-paymentcryptography-key-keymodesofuse-verify): Boolean
  [Wrap](#cfn-paymentcryptography-key-keymodesofuse-wrap): Boolean
```

## Properties
<a name="aws-properties-paymentcryptography-key-keymodesofuse-properties"></a>

`Decrypt`  <a name="cfn-paymentcryptography-key-keymodesofuse-decrypt"></a>
Specifies whether an AWS Payment Cryptography key can be used to decrypt data.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeriveKey`  <a name="cfn-paymentcryptography-key-keymodesofuse-derivekey"></a>
Specifies whether an AWS Payment Cryptography key can be used to derive new keys.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Encrypt`  <a name="cfn-paymentcryptography-key-keymodesofuse-encrypt"></a>
Specifies whether an AWS Payment Cryptography key can be used to encrypt data.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Generate`  <a name="cfn-paymentcryptography-key-keymodesofuse-generate"></a>
Specifies whether an AWS Payment Cryptography key can be used to generate and verify other card and PIN verification keys.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NoRestrictions`  <a name="cfn-paymentcryptography-key-keymodesofuse-norestrictions"></a>
Specifies whether an AWS Payment Cryptography key has no special restrictions other than the restrictions implied by `KeyUsage`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Sign`  <a name="cfn-paymentcryptography-key-keymodesofuse-sign"></a>
Specifies whether an AWS Payment Cryptography key can be used for signing.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Unwrap`  <a name="cfn-paymentcryptography-key-keymodesofuse-unwrap"></a>
Property description not available.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Verify`  <a name="cfn-paymentcryptography-key-keymodesofuse-verify"></a>
Specifies whether an AWS Payment Cryptography key can be used to verify signatures.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Wrap`  <a name="cfn-paymentcryptography-key-keymodesofuse-wrap"></a>
Specifies whether an AWS Payment Cryptography key can be used to wrap other keys.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::PaymentCryptography::Key ReplicationStatusType
<a name="aws-properties-paymentcryptography-key-replicationstatustype"></a>

Represents the replication status information for a key in a replication region for [Multi-Region key replication](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html).

This structure contains details about the current state of key replication, including any status messages and operational information about the replication process.

## Syntax
<a name="aws-properties-paymentcryptography-key-replicationstatustype-syntax"></a>

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

### JSON
<a name="aws-properties-paymentcryptography-key-replicationstatustype-syntax.json"></a>

```
{
  "[Status](#cfn-paymentcryptography-key-replicationstatustype-status)" : String,
  "[StatusMessage](#cfn-paymentcryptography-key-replicationstatustype-statusmessage)" : String
}
```

### YAML
<a name="aws-properties-paymentcryptography-key-replicationstatustype-syntax.yaml"></a>

```
  [Status](#cfn-paymentcryptography-key-replicationstatustype-status): String
  [StatusMessage](#cfn-paymentcryptography-key-replicationstatustype-statusmessage): String
```

## Properties
<a name="aws-properties-paymentcryptography-key-replicationstatustype-properties"></a>

`Status`  <a name="cfn-paymentcryptography-key-replicationstatustype-status"></a>
The current status of key replication in this AWS Region.  
This field indicates whether the key replication is in progress, completed successfully, or has encountered an error. Possible values include states such as `SYNCRHONIZED`, `IN_PROGRESS`, `DELETE_IN_PROGRESS`, or `FAILED`. This provides visibility into the replication process for monitoring and troubleshooting purposes.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `IN_PROGRESS | DELETE_IN_PROGRESS | FAILED | SYNCHRONIZED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatusMessage`  <a name="cfn-paymentcryptography-key-replicationstatustype-statusmessage"></a>
A message that provides additional information about the current replication status of the key.  
This field contains details about any issues or progress updates related to key replication operations. It may include information about replication failures, synchronization status, or other operational details.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::PaymentCryptography::Key Tag
<a name="aws-properties-paymentcryptography-key-tag"></a>

A structure that contains information about a tag.

## Syntax
<a name="aws-properties-paymentcryptography-key-tag-syntax"></a>

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

### JSON
<a name="aws-properties-paymentcryptography-key-tag-syntax.json"></a>

```
{
  "[Key](#cfn-paymentcryptography-key-tag-key)" : String,
  "[Value](#cfn-paymentcryptography-key-tag-value)" : String
}
```

### YAML
<a name="aws-properties-paymentcryptography-key-tag-syntax.yaml"></a>

```
  [Key](#cfn-paymentcryptography-key-tag-key): String
  [Value](#cfn-paymentcryptography-key-tag-value): String
```

## Properties
<a name="aws-properties-paymentcryptography-key-tag-properties"></a>

`Key`  <a name="cfn-paymentcryptography-key-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-paymentcryptography-key-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)